barman-2.18/ 0000755 0006212 0006212 00000000000 14172556766 011103 5 ustar 0000000 0000000 barman-2.18/MANIFEST.in 0000644 0006212 0006212 00000000304 14172556763 012633 0 ustar 0000000 0000000 recursive-include barman *.py
recursive-include rpm *
recursive-include doc *
include scripts/barman.bash_completion
include AUTHORS NEWS ChangeLog LICENSE MANIFEST.in setup.py INSTALL README.rst
barman-2.18/barman/ 0000755 0006212 0006212 00000000000 14172556766 012343 5 ustar 0000000 0000000 barman-2.18/barman/hooks.py 0000644 0006212 0006212 00000026202 14172556763 014037 0 ustar 0000000 0000000 # -*- coding: utf-8 -*-
# © Copyright EnterpriseDB UK Limited 2011-2022
#
# This file is part of Barman.
#
# Barman is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Barman is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Barman. If not, see .
"""
This module contains the logic to run hook scripts
"""
import json
import logging
import time
from barman import version
from barman.command_wrappers import Command
from barman.exceptions import AbortedRetryHookScript, UnknownBackupIdException
from barman.utils import force_str
_logger = logging.getLogger(__name__)
class HookScriptRunner(object):
def __init__(
self, backup_manager, name, phase=None, error=None, retry=False, **extra_env
):
"""
Execute a hook script managing its environment
"""
self.backup_manager = backup_manager
self.name = name
self.extra_env = extra_env
self.phase = phase
self.error = error
self.retry = retry
self.environment = None
self.exit_status = None
self.exception = None
self.script = None
self.reset()
def reset(self):
"""
Reset the status of the class.
"""
self.environment = dict(self.extra_env)
config_file = self.backup_manager.config.config.config_file
self.environment.update(
{
"BARMAN_VERSION": version.__version__,
"BARMAN_SERVER": self.backup_manager.config.name,
"BARMAN_CONFIGURATION": config_file,
"BARMAN_HOOK": self.name,
"BARMAN_RETRY": str(1 if self.retry else 0),
}
)
if self.error:
self.environment["BARMAN_ERROR"] = force_str(self.error)
if self.phase:
self.environment["BARMAN_PHASE"] = self.phase
script_config_name = "%s_%s" % (self.phase, self.name)
else:
script_config_name = self.name
self.script = getattr(self.backup_manager.config, script_config_name, None)
self.exit_status = None
self.exception = None
def env_from_backup_info(self, backup_info):
"""
Prepare the environment for executing a script
:param BackupInfo backup_info: the backup metadata
"""
try:
previous_backup = self.backup_manager.get_previous_backup(
backup_info.backup_id
)
if previous_backup:
previous_backup_id = previous_backup.backup_id
else:
previous_backup_id = ""
except UnknownBackupIdException:
previous_backup_id = ""
try:
next_backup = self.backup_manager.get_next_backup(backup_info.backup_id)
if next_backup:
next_backup_id = next_backup.backup_id
else:
next_backup_id = ""
except UnknownBackupIdException:
next_backup_id = ""
self.environment.update(
{
"BARMAN_BACKUP_DIR": backup_info.get_basebackup_directory(),
"BARMAN_BACKUP_ID": backup_info.backup_id,
"BARMAN_PREVIOUS_ID": previous_backup_id,
"BARMAN_NEXT_ID": next_backup_id,
"BARMAN_STATUS": backup_info.status,
"BARMAN_ERROR": backup_info.error or "",
}
)
def env_from_wal_info(self, wal_info, full_path=None, error=None):
"""
Prepare the environment for executing a script
:param WalFileInfo wal_info: the backup metadata
:param str full_path: override wal_info.fullpath() result
:param str|Exception error: An error message in case of failure
"""
self.environment.update(
{
"BARMAN_SEGMENT": wal_info.name,
"BARMAN_FILE": str(
full_path
if full_path is not None
else wal_info.fullpath(self.backup_manager.server)
),
"BARMAN_SIZE": str(wal_info.size),
"BARMAN_TIMESTAMP": str(wal_info.time),
"BARMAN_COMPRESSION": wal_info.compression or "",
"BARMAN_ERROR": force_str(error or ""),
}
)
def env_from_recover(
self, backup_info, dest, tablespaces, remote_command, error=None, **kwargs
):
"""
Prepare the environment for executing a script
:param BackupInfo backup_info: the backup metadata
:param str dest: the destination directory
:param dict[str,str]|None tablespaces: a tablespace name -> location
map (for relocation)
:param str|None remote_command: default None. The remote command
to recover the base backup, in case of remote backup.
:param str|Exception error: An error message in case of failure
"""
self.env_from_backup_info(backup_info)
# Prepare a JSON representation of tablespace map
tablespaces_map = ""
if tablespaces:
tablespaces_map = json.dumps(tablespaces, sort_keys=True)
# Prepare a JSON representation of additional recovery options
# Skip any empty argument
kwargs_filtered = dict([(k, v) for k, v in kwargs.items() if v])
recover_options = ""
if kwargs_filtered:
recover_options = json.dumps(kwargs_filtered, sort_keys=True)
self.environment.update(
{
"BARMAN_DESTINATION_DIRECTORY": str(dest),
"BARMAN_TABLESPACES": tablespaces_map,
"BARMAN_REMOTE_COMMAND": str(remote_command or ""),
"BARMAN_RECOVER_OPTIONS": recover_options,
"BARMAN_ERROR": force_str(error or ""),
}
)
def run(self):
"""
Run a a hook script if configured.
This method must never throw any exception
"""
# noinspection PyBroadException
try:
if self.script:
_logger.debug("Attempt to run %s: %s", self.name, self.script)
cmd = Command(
self.script,
env_append=self.environment,
path=self.backup_manager.server.path,
shell=True,
check=False,
)
self.exit_status = cmd()
if self.exit_status != 0:
details = "%s returned %d\nOutput details:\n" % (
self.script,
self.exit_status,
)
details += cmd.out
details += cmd.err
_logger.warning(details)
else:
_logger.debug("%s returned %d", self.script, self.exit_status)
return self.exit_status
except Exception as e:
_logger.exception("Exception running %s", self.name)
self.exception = e
return None
class RetryHookScriptRunner(HookScriptRunner):
"""
A 'retry' hook script is a special kind of hook script that Barman
tries to run indefinitely until it either returns a SUCCESS or
ABORT exit code.
Retry hook scripts are executed immediately before (pre) and after (post)
the command execution. Standard hook scripts are executed immediately
before (pre) and after (post) the retry hook scripts.
"""
# Failed attempts before sleeping for NAP_TIME seconds
ATTEMPTS_BEFORE_NAP = 5
# Short break after a failure (in seconds)
BREAK_TIME = 3
# Long break (nap, in seconds) after ATTEMPTS_BEFORE_NAP failures
NAP_TIME = 60
# ABORT (and STOP) exit code
EXIT_ABORT_STOP = 63
# ABORT (and CONTINUE) exit code
EXIT_ABORT_CONTINUE = 62
# SUCCESS exit code
EXIT_SUCCESS = 0
def __init__(self, backup_manager, name, phase=None, error=None, **extra_env):
super(RetryHookScriptRunner, self).__init__(
backup_manager, name, phase, error, retry=True, **extra_env
)
def run(self):
"""
Run a a 'retry' hook script, if required by configuration.
Barman will retry to run the script indefinitely until it returns
a EXIT_SUCCESS, or an EXIT_ABORT_CONTINUE, or an EXIT_ABORT_STOP code.
There are BREAK_TIME seconds of sleep between every try.
Every ATTEMPTS_BEFORE_NAP failures, Barman will sleep
for NAP_TIME seconds.
"""
# If there is no script, exit
if self.script is not None:
# Keep track of the number of attempts
attempts = 1
while True:
# Run the script using the standard hook method (inherited)
super(RetryHookScriptRunner, self).run()
# Run the script until it returns EXIT_ABORT_CONTINUE,
# or an EXIT_ABORT_STOP, or EXIT_SUCCESS
if self.exit_status in (
self.EXIT_ABORT_CONTINUE,
self.EXIT_ABORT_STOP,
self.EXIT_SUCCESS,
):
break
# Check for the number of attempts
if attempts <= self.ATTEMPTS_BEFORE_NAP:
attempts += 1
# Take a short break
_logger.debug("Retry again in %d seconds", self.BREAK_TIME)
time.sleep(self.BREAK_TIME)
else:
# Reset the attempt number and take a longer nap
_logger.debug(
"Reached %d failures. Take a nap "
"then retry again in %d seconds",
self.ATTEMPTS_BEFORE_NAP,
self.NAP_TIME,
)
attempts = 1
time.sleep(self.NAP_TIME)
# Outside the loop check for the exit code.
if self.exit_status == self.EXIT_ABORT_CONTINUE:
# Warn the user if the script exited with EXIT_ABORT_CONTINUE
# Notify EXIT_ABORT_CONTINUE exit status because success and
# failures are already managed in the superclass run method
_logger.warning(
"%s was aborted (got exit status %d, Barman resumes)",
self.script,
self.exit_status,
)
elif self.exit_status == self.EXIT_ABORT_STOP:
# Log the error and raise AbortedRetryHookScript exception
_logger.error(
"%s was aborted (got exit status %d, Barman requested to stop)",
self.script,
self.exit_status,
)
raise AbortedRetryHookScript(self)
return self.exit_status
barman-2.18/barman/postgres.py 0000644 0006212 0006212 00000166645 14172556763 014602 0 ustar 0000000 0000000 # -*- coding: utf-8 -*-
# © Copyright EnterpriseDB UK Limited 2011-2022
#
# This file is part of Barman.
#
# Barman is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Barman is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Barman. If not, see .
"""
This module represents the interface towards a PostgreSQL server.
"""
import atexit
import logging
from abc import ABCMeta
import psycopg2
from psycopg2.errorcodes import DUPLICATE_OBJECT, OBJECT_IN_USE, UNDEFINED_OBJECT
from psycopg2.extensions import STATUS_IN_TRANSACTION, STATUS_READY
from psycopg2.extras import DictCursor, NamedTupleCursor
from barman.exceptions import (
ConninfoException,
PostgresAppNameError,
PostgresConnectionError,
PostgresDuplicateReplicationSlot,
PostgresException,
PostgresInvalidReplicationSlot,
PostgresIsInRecovery,
PostgresReplicationSlotInUse,
PostgresReplicationSlotsFull,
BackupFunctionsAccessRequired,
PostgresSuperuserRequired,
PostgresUnsupportedFeature,
)
from barman.infofile import Tablespace
from barman.postgres_plumbing import function_name_map
from barman.remote_status import RemoteStatusMixin
from barman.utils import force_str, simplify_version, with_metaclass
from barman.xlog import DEFAULT_XLOG_SEG_SIZE
# This is necessary because the CONFIGURATION_LIMIT_EXCEEDED constant
# has been added in psycopg2 2.5, but Barman supports version 2.4.2+ so
# in case of import error we declare a constant providing the correct value.
try:
from psycopg2.errorcodes import CONFIGURATION_LIMIT_EXCEEDED
except ImportError:
CONFIGURATION_LIMIT_EXCEEDED = "53400"
_logger = logging.getLogger(__name__)
_live_connections = []
"""
List of connections to be closed at the interpreter shutdown
"""
@atexit.register
def _atexit():
"""
Ensure that all the connections are correctly closed
at interpreter shutdown
"""
# Take a copy of the list because the conn.close() method modify it
for conn in list(_live_connections):
_logger.warning(
"Forcing %s cleanup during process shut down.", conn.__class__.__name__
)
conn.close()
class PostgreSQL(with_metaclass(ABCMeta, RemoteStatusMixin)):
"""
This abstract class represents a generic interface to a PostgreSQL server.
"""
CHECK_QUERY = "SELECT 1"
def __init__(self, conninfo):
"""
Abstract base class constructor for PostgreSQL interface.
:param str conninfo: Connection information (aka DSN)
"""
super(PostgreSQL, self).__init__()
self.conninfo = conninfo
self._conn = None
self.allow_reconnect = True
# Build a dictionary with connection info parameters
# This is mainly used to speed up search in conninfo
try:
self.conn_parameters = self.parse_dsn(conninfo)
except (ValueError, TypeError) as e:
_logger.debug(e)
raise ConninfoException(
'Cannot connect to postgres: "%s" '
"is not a valid connection string" % conninfo
)
@staticmethod
def parse_dsn(dsn):
"""
Parse connection parameters from 'conninfo'
:param str dsn: Connection information (aka DSN)
:rtype: dict[str,str]
"""
# TODO: this might be made more robust in the future
return dict(x.split("=", 1) for x in dsn.split())
@staticmethod
def encode_dsn(parameters):
"""
Build a connection string from a dictionary of connection
parameters
:param dict[str,str] parameters: Connection parameters
:rtype: str
"""
# TODO: this might be made more robust in the future
return " ".join(["%s=%s" % (k, v) for k, v in sorted(parameters.items())])
def get_connection_string(self, application_name=None):
"""
Return the connection string, adding the application_name parameter
if requested, unless already defined by user in the connection string
:param str application_name: the application_name to add
:return str: the connection string
"""
conn_string = self.conninfo
# check if the application name is already defined by user
if application_name and "application_name" not in self.conn_parameters:
# Then add the it to the connection string
conn_string += " application_name=%s" % application_name
# adopt a secure schema-usage pattern. See:
# https://www.postgresql.org/docs/current/libpq-connect.html
if "options" not in self.conn_parameters:
conn_string += " options=-csearch_path="
return conn_string
def connect(self):
"""
Generic function for Postgres connection (using psycopg2)
"""
if not self._check_connection():
try:
self._conn = psycopg2.connect(self.conninfo)
self._conn.autocommit = True
# If psycopg2 fails to connect to the host,
# raise the appropriate exception
except psycopg2.DatabaseError as e:
raise PostgresConnectionError(force_str(e).strip())
# Register the connection to the list of live connections
_live_connections.append(self)
return self._conn
def _check_connection(self):
"""
Return false if the connection is broken
:rtype: bool
"""
# If the connection is not present return False
if not self._conn:
return False
# Check if the connection works by running 'SELECT 1'
cursor = None
initial_status = None
try:
initial_status = self._conn.status
cursor = self._conn.cursor()
cursor.execute(self.CHECK_QUERY)
# Rollback if initial status was IDLE because the CHECK QUERY
# has started a new transaction.
if initial_status == STATUS_READY:
self._conn.rollback()
except psycopg2.DatabaseError:
# Connection is broken, so we need to reconnect
self.close()
# Raise an error if reconnect is not allowed
if not self.allow_reconnect:
raise PostgresConnectionError(
"Connection lost, reconnection not allowed"
)
return False
finally:
if cursor:
cursor.close()
return True
def close(self):
"""
Close the connection to PostgreSQL
"""
if self._conn:
# If the connection is still alive, rollback and close it
if not self._conn.closed:
if self._conn.status == STATUS_IN_TRANSACTION:
self._conn.rollback()
self._conn.close()
# Remove the connection from the live connections list
self._conn = None
_live_connections.remove(self)
def _cursor(self, *args, **kwargs):
"""
Return a cursor
"""
conn = self.connect()
return conn.cursor(*args, **kwargs)
@property
def server_version(self):
"""
Version of PostgreSQL (returned by psycopg2)
"""
conn = self.connect()
return conn.server_version
@property
def server_txt_version(self):
"""
Human readable version of PostgreSQL (calculated from server_version)
:rtype: str|None
"""
try:
conn = self.connect()
major = int(conn.server_version / 10000)
minor = int(conn.server_version / 100 % 100)
patch = int(conn.server_version % 100)
if major < 10:
return "%d.%d.%d" % (major, minor, patch)
if minor != 0:
_logger.warning(
"Unexpected non zero minor version %s in %s",
minor,
conn.server_version,
)
return "%d.%d" % (major, patch)
except PostgresConnectionError as e:
_logger.debug(
"Error retrieving PostgreSQL version: %s", force_str(e).strip()
)
return None
@property
def server_major_version(self):
"""
PostgreSQL major version (calculated from server_txt_version)
:rtype: str|None
"""
result = self.server_txt_version
if result is not None:
return simplify_version(result)
return None
class StreamingConnection(PostgreSQL):
"""
This class represents a streaming connection to a PostgreSQL server.
"""
CHECK_QUERY = "IDENTIFY_SYSTEM"
def __init__(self, conninfo):
"""
Streaming connection constructor
:param str conninfo: Connection information (aka DSN)
"""
super(StreamingConnection, self).__init__(conninfo)
# Make sure we connect using the 'replication' option which
# triggers streaming replication protocol communication
self.conn_parameters["replication"] = "true"
# ensure that the datestyle is set to iso, working around an
# issue in some psycopg2 versions
self.conn_parameters["options"] = "-cdatestyle=iso"
# Override 'dbname' parameter. This operation is required to mimic
# the behaviour of pg_receivexlog and pg_basebackup
self.conn_parameters["dbname"] = "replication"
# Rebuild the conninfo string from the modified parameter lists
self.conninfo = self.encode_dsn(self.conn_parameters)
def connect(self):
"""
Connect to the PostgreSQL server. It reuses an existing connection.
:returns: the connection to the server
"""
if self._check_connection():
return self._conn
# Build a connection
self._conn = super(StreamingConnection, self).connect()
return self._conn
def fetch_remote_status(self):
"""
Returns the status of the connection to the PostgreSQL server.
This method does not raise any exception in case of errors,
but set the missing values to None in the resulting dictionary.
:rtype: dict[str, None|str]
"""
result = dict.fromkeys(
(
"connection_error",
"streaming_supported",
"streaming",
"streaming_systemid",
"timeline",
"xlogpos",
),
None,
)
try:
# If the server is too old to support `pg_receivexlog`,
# exit immediately.
# This needs to be protected by the try/except because
# `self.server_version` can raise a PostgresConnectionError
if self.server_version < 90200:
result["streaming_supported"] = False
return result
result["streaming_supported"] = True
# Execute a IDENTIFY_SYSYEM to check the connection
cursor = self._cursor()
cursor.execute("IDENTIFY_SYSTEM")
row = cursor.fetchone()
# If something has been returned, barman is connected
# to a replication backend
if row:
result["streaming"] = True
# IDENTIFY_SYSTEM always returns at least two values
result["streaming_systemid"] = row[0]
result["timeline"] = row[1]
# PostgreSQL 9.1+ returns also the current xlog flush location
if len(row) > 2:
result["xlogpos"] = row[2]
except psycopg2.ProgrammingError:
# This is not a streaming connection
result["streaming"] = False
except PostgresConnectionError as e:
result["connection_error"] = force_str(e).strip()
_logger.warning(
"Error retrieving PostgreSQL status: %s", force_str(e).strip()
)
return result
def create_physical_repslot(self, slot_name):
"""
Create a physical replication slot using the streaming connection
:param str slot_name: Replication slot name
"""
cursor = self._cursor()
try:
# In the following query, the slot name is directly passed
# to the CREATE_REPLICATION_SLOT command, without any
# quoting. This is a characteristic of the streaming
# connection, otherwise if will fail with a generic
# "syntax error"
cursor.execute("CREATE_REPLICATION_SLOT %s PHYSICAL" % slot_name)
_logger.info("Replication slot '%s' successfully created", slot_name)
except psycopg2.DatabaseError as exc:
if exc.pgcode == DUPLICATE_OBJECT:
# A replication slot with the same name exists
raise PostgresDuplicateReplicationSlot()
elif exc.pgcode == CONFIGURATION_LIMIT_EXCEEDED:
# Unable to create a new physical replication slot.
# All slots are full.
raise PostgresReplicationSlotsFull()
else:
raise PostgresException(force_str(exc).strip())
def drop_repslot(self, slot_name):
"""
Drop a physical replication slot using the streaming connection
:param str slot_name: Replication slot name
"""
cursor = self._cursor()
try:
# In the following query, the slot name is directly passed
# to the DROP_REPLICATION_SLOT command, without any
# quoting. This is a characteristic of the streaming
# connection, otherwise if will fail with a generic
# "syntax error"
cursor.execute("DROP_REPLICATION_SLOT %s" % slot_name)
_logger.info("Replication slot '%s' successfully dropped", slot_name)
except psycopg2.DatabaseError as exc:
if exc.pgcode == UNDEFINED_OBJECT:
# A replication slot with the that name does not exist
raise PostgresInvalidReplicationSlot()
if exc.pgcode == OBJECT_IN_USE:
# The replication slot is still in use
raise PostgresReplicationSlotInUse()
else:
raise PostgresException(force_str(exc).strip())
class PostgreSQLConnection(PostgreSQL):
"""
This class represents a standard client connection to a PostgreSQL server.
"""
# Streaming replication client types
STANDBY = 1
WALSTREAMER = 2
ANY_STREAMING_CLIENT = (STANDBY, WALSTREAMER)
def __init__(
self,
conninfo,
immediate_checkpoint=False,
slot_name=None,
application_name="barman",
):
"""
PostgreSQL connection constructor.
:param str conninfo: Connection information (aka DSN)
:param bool immediate_checkpoint: Whether to do an immediate checkpoint
when start a backup
:param str|None slot_name: Replication slot name
"""
super(PostgreSQLConnection, self).__init__(conninfo)
self.immediate_checkpoint = immediate_checkpoint
self.slot_name = slot_name
self.application_name = application_name
self.configuration_files = None
def connect(self):
"""
Connect to the PostgreSQL server. It reuses an existing connection.
"""
if self._check_connection():
return self._conn
self._conn = super(PostgreSQLConnection, self).connect()
server_version = self._conn.server_version
use_app_name = "application_name" in self.conn_parameters
if server_version >= 90000 and not use_app_name:
try:
cur = self._conn.cursor()
# Do not use parameter substitution with SET
cur.execute("SET application_name TO %s" % self.application_name)
cur.close()
# If psycopg2 fails to set the application name,
# raise the appropriate exception
except psycopg2.ProgrammingError as e:
raise PostgresAppNameError(force_str(e).strip())
return self._conn
@property
def server_txt_version(self):
"""
Human readable version of PostgreSQL (returned by the server).
Note: The return value of this function is used when composing include
patterns which are passed to rsync when copying tablespaces. If the
value does not exactly match the PostgreSQL version then Barman may
fail to copy tablespace files during a backup.
"""
try:
cur = self._cursor()
cur.execute("SELECT version()")
version_string = cur.fetchone()[0]
platform, version = version_string.split()[:2]
# EPAS <= 10 will return a version string which starts with
# EnterpriseDB followed by the PostgreSQL version with an
# additional version field. This additional field must be discarded
# so that we return the exact PostgreSQL version. Later versions of
# EPAS report the PostgreSQL version directly so do not need
# special handling.
if platform == "EnterpriseDB":
return ".".join(version.split(".")[:-1])
else:
return version
except (PostgresConnectionError, psycopg2.Error) as e:
_logger.debug(
"Error retrieving PostgreSQL version: %s", force_str(e).strip()
)
return None
@property
def has_pgespresso(self):
"""
Returns true if the `pgespresso` extension is available
"""
try:
# pg_extension is only available from Postgres 9.1+
if self.server_version < 90100:
return False
cur = self._cursor()
cur.execute(
"SELECT count(*) FROM pg_extension WHERE extname = 'pgespresso'"
)
q_result = cur.fetchone()[0]
return q_result > 0
except (PostgresConnectionError, psycopg2.Error) as e:
_logger.debug(
"Error retrieving pgespresso information: %s", force_str(e).strip()
)
return None
@property
def is_in_recovery(self):
"""
Returns true if PostgreSQL server is in recovery mode (hot standby)
"""
try:
# pg_is_in_recovery is only available from Postgres 9.0+
if self.server_version < 90000:
return False
cur = self._cursor()
cur.execute("SELECT pg_is_in_recovery()")
return cur.fetchone()[0]
except (PostgresConnectionError, psycopg2.Error) as e:
_logger.debug(
"Error calling pg_is_in_recovery() function: %s", force_str(e).strip()
)
return None
@property
def is_superuser(self):
"""
Returns true if current user has superuser privileges
"""
try:
cur = self._cursor()
cur.execute("SELECT usesuper FROM pg_user WHERE usename = CURRENT_USER")
return cur.fetchone()[0]
except (PostgresConnectionError, psycopg2.Error) as e:
_logger.debug(
"Error calling is_superuser() function: %s", force_str(e).strip()
)
return None
@property
def has_backup_privileges(self):
"""
Returns true if current user is superuser or, for PostgreSQL 10
or above, is a standard user that has grants to read server
settings and to execute all the functions needed for
exclusive/concurrent backup control and WAL control.
"""
# pg_monitor / pg_read_all_settings only available from v10
if self.server_version < 100000:
return self.is_superuser
backup_check_query = """
SELECT
usesuper
OR
(
(
pg_has_role(CURRENT_USER, 'pg_monitor', 'MEMBER')
OR
(
pg_has_role(CURRENT_USER, 'pg_read_all_settings', 'MEMBER')
AND pg_has_role(CURRENT_USER, 'pg_read_all_stats', 'MEMBER')
)
)
AND has_function_privilege(
CURRENT_USER, 'pg_start_backup(text,bool,bool)', 'EXECUTE')
AND
(
has_function_privilege(
CURRENT_USER, 'pg_stop_backup()', 'EXECUTE')
OR has_function_privilege(
CURRENT_USER, 'pg_stop_backup(bool,bool)', 'EXECUTE')
)
AND has_function_privilege(
CURRENT_USER, 'pg_switch_wal()', 'EXECUTE')
AND has_function_privilege(
CURRENT_USER, 'pg_create_restore_point(text)', 'EXECUTE')
)
FROM
pg_user
WHERE
usename = CURRENT_USER
"""
try:
cur = self._cursor()
cur.execute(backup_check_query)
return cur.fetchone()[0]
except (PostgresConnectionError, psycopg2.Error) as e:
_logger.debug(
"Error checking privileges for functions needed for backups: %s",
force_str(e).strip(),
)
return None
@property
def current_xlog_info(self):
"""
Get detailed information about the current WAL position in PostgreSQL.
This method returns a dictionary containing the following data:
* location
* file_name
* file_offset
* timestamp
When executed on a standby server file_name and file_offset are always
None
:rtype: psycopg2.extras.DictRow
"""
try:
cur = self._cursor(cursor_factory=DictCursor)
if not self.is_in_recovery:
cur.execute(
"SELECT location, "
"({pg_walfile_name_offset}(location)).*, "
"CURRENT_TIMESTAMP AS timestamp "
"FROM {pg_current_wal_lsn}() AS location".format(**self.name_map)
)
return cur.fetchone()
else:
cur.execute(
"SELECT location, "
"NULL AS file_name, "
"NULL AS file_offset, "
"CURRENT_TIMESTAMP AS timestamp "
"FROM {pg_last_wal_replay_lsn}() AS location".format(
**self.name_map
)
)
return cur.fetchone()
except (PostgresConnectionError, psycopg2.Error) as e:
_logger.debug(
"Error retrieving current xlog detailed information: %s",
force_str(e).strip(),
)
return None
@property
def current_xlog_file_name(self):
"""
Get current WAL file from PostgreSQL
:return str: current WAL file in PostgreSQL
"""
current_xlog_info = self.current_xlog_info
if current_xlog_info is not None:
return current_xlog_info["file_name"]
return None
@property
def xlog_segment_size(self):
"""
Retrieve the size of one WAL file.
In PostgreSQL 11, users will be able to change the WAL size
at runtime. Up to PostgreSQL 10, included, the WAL size can be changed
at compile time
:return: The wal size (In bytes)
"""
# Prior to PostgreSQL 8.4, the wal segment size was not configurable,
# even in compilation
if self.server_version < 80400:
return DEFAULT_XLOG_SEG_SIZE
try:
cur = self._cursor(cursor_factory=DictCursor)
# We can't use the `get_setting` method here, because it
# use `SHOW`, returning an human readable value such as "16MB",
# while we prefer a raw value such as 16777216.
cur.execute("SELECT setting FROM pg_settings WHERE name='wal_segment_size'")
result = cur.fetchone()
wal_segment_size = int(result[0])
# Prior to PostgreSQL 11, the wal segment size is returned in
# blocks
if self.server_version < 110000:
cur.execute(
"SELECT setting FROM pg_settings WHERE name='wal_block_size'"
)
result = cur.fetchone()
wal_block_size = int(result[0])
wal_segment_size *= wal_block_size
return wal_segment_size
except ValueError as e:
_logger.error(
"Error retrieving current xlog segment size: %s",
force_str(e).strip(),
)
return None
@property
def current_xlog_location(self):
"""
Get current WAL location from PostgreSQL
:return str: current WAL location in PostgreSQL
"""
current_xlog_info = self.current_xlog_info
if current_xlog_info is not None:
return current_xlog_info["location"]
return None
@property
def current_size(self):
"""
Returns the total size of the PostgreSQL server
(requires superuser or pg_read_all_stats)
"""
if not self.has_backup_privileges:
return None
try:
cur = self._cursor()
cur.execute("SELECT sum(pg_tablespace_size(oid)) FROM pg_tablespace")
return cur.fetchone()[0]
except (PostgresConnectionError, psycopg2.Error) as e:
_logger.debug(
"Error retrieving PostgreSQL total size: %s", force_str(e).strip()
)
return None
@property
def archive_timeout(self):
"""
Retrieve the archive_timeout setting in PostgreSQL
:return: The archive timeout (in seconds)
"""
try:
cur = self._cursor(cursor_factory=DictCursor)
# We can't use the `get_setting` method here, because it
# uses `SHOW`, returning an human readable value such as "5min",
# while we prefer a raw value such as 300.
cur.execute("SELECT setting FROM pg_settings WHERE name='archive_timeout'")
result = cur.fetchone()
archive_timeout = int(result[0])
return archive_timeout
except ValueError as e:
_logger.error("Error retrieving archive_timeout: %s", force_str(e).strip())
return None
@property
def checkpoint_timeout(self):
"""
Retrieve the checkpoint_timeout setting in PostgreSQL
:return: The checkpoint timeout (in seconds)
"""
try:
cur = self._cursor(cursor_factory=DictCursor)
# We can't use the `get_setting` method here, because it
# uses `SHOW`, returning an human readable value such as "5min",
# while we prefer a raw value such as 300.
cur.execute(
"SELECT setting FROM pg_settings WHERE name='checkpoint_timeout'"
)
result = cur.fetchone()
checkpoint_timeout = int(result[0])
return checkpoint_timeout
except ValueError as e:
_logger.error(
"Error retrieving checkpoint_timeout: %s", force_str(e).strip()
)
return None
def get_archiver_stats(self):
"""
This method gathers statistics from pg_stat_archiver.
Only for Postgres 9.4+ or greater. If not available, returns None.
:return dict|None: a dictionary containing Postgres statistics from
pg_stat_archiver or None
"""
try:
# pg_stat_archiver is only available from Postgres 9.4+
if self.server_version < 90400:
return None
cur = self._cursor(cursor_factory=DictCursor)
# Select from pg_stat_archiver statistics view,
# retrieving statistics about WAL archiver process activity,
# also evaluating if the server is archiving without issues
# and the archived WALs per second rate.
#
# We are using current_settings to check for archive_mode=always.
# current_setting does normalise its output so we can just
# check for 'always' settings using a direct string
# comparison
cur.execute(
"SELECT *, "
"current_setting('archive_mode') IN ('on', 'always') "
"AND (last_failed_wal IS NULL "
"OR last_failed_wal LIKE '%.history' "
"AND substring(last_failed_wal from 1 for 8) "
"<= substring(last_archived_wal from 1 for 8) "
"OR last_failed_time <= last_archived_time) "
"AS is_archiving, "
"CAST (archived_count AS NUMERIC) "
"/ EXTRACT (EPOCH FROM age(now(), stats_reset)) "
"AS current_archived_wals_per_second "
"FROM pg_stat_archiver"
)
return cur.fetchone()
except (PostgresConnectionError, psycopg2.Error) as e:
_logger.debug(
"Error retrieving pg_stat_archive data: %s", force_str(e).strip()
)
return None
def fetch_remote_status(self):
"""
Get the status of the PostgreSQL server
This method does not raise any exception in case of errors,
but set the missing values to None in the resulting dictionary.
:rtype: dict[str, None|str]
"""
# PostgreSQL settings to get from the server (requiring superuser)
pg_superuser_settings = ["data_directory"]
# PostgreSQL settings to get from the server
pg_settings = []
pg_query_keys = [
"server_txt_version",
"is_superuser",
"is_in_recovery",
"current_xlog",
"pgespresso_installed",
"replication_slot_support",
"replication_slot",
"synchronous_standby_names",
"postgres_systemid",
]
# Initialise the result dictionary setting all the values to None
result = dict.fromkeys(
pg_superuser_settings + pg_settings + pg_query_keys, None
)
try:
# Retrieve wal_level, hot_standby and max_wal_senders
# only if version is >= 9.0
if self.server_version >= 90000:
pg_settings.append("wal_level")
pg_settings.append("hot_standby")
pg_settings.append("max_wal_senders")
# Retrieve wal_keep_segments from version 9.0 onwards, until
# version 13.0, where it was renamed to wal_keep_size
if self.server_version < 130000:
pg_settings.append("wal_keep_segments")
else:
pg_settings.append("wal_keep_size")
if self.server_version >= 90300:
pg_settings.append("data_checksums")
if self.server_version >= 90400:
pg_settings.append("max_replication_slots")
if self.server_version >= 90500:
pg_settings.append("wal_compression")
# retrieves superuser settings
if self.has_backup_privileges:
for name in pg_superuser_settings:
result[name] = self.get_setting(name)
# retrieves standard settings
for name in pg_settings:
result[name] = self.get_setting(name)
result["is_superuser"] = self.is_superuser
result["has_backup_privileges"] = self.has_backup_privileges
result["is_in_recovery"] = self.is_in_recovery
result["server_txt_version"] = self.server_txt_version
result["pgespresso_installed"] = self.has_pgespresso
current_xlog_info = self.current_xlog_info
if current_xlog_info:
result["current_lsn"] = current_xlog_info["location"]
result["current_xlog"] = current_xlog_info["file_name"]
else:
result["current_lsn"] = None
result["current_xlog"] = None
result["current_size"] = self.current_size
result["archive_timeout"] = self.archive_timeout
result["checkpoint_timeout"] = self.checkpoint_timeout
result["xlog_segment_size"] = self.xlog_segment_size
result.update(self.get_configuration_files())
# Retrieve the replication_slot status
result["replication_slot_support"] = False
if self.server_version >= 90400:
result["replication_slot_support"] = True
if self.slot_name is not None:
result["replication_slot"] = self.get_replication_slot(
self.slot_name
)
# Retrieve the list of synchronous standby names
result["synchronous_standby_names"] = []
if self.server_version >= 90100:
result[
"synchronous_standby_names"
] = self.get_synchronous_standby_names()
if self.server_version >= 90600:
result["postgres_systemid"] = self.get_systemid()
except (PostgresConnectionError, psycopg2.Error) as e:
_logger.warning(
"Error retrieving PostgreSQL status: %s", force_str(e).strip()
)
return result
def get_systemid(self):
"""
Get a Postgres instance systemid
"""
if self.server_version < 90600:
return
try:
cur = self._cursor()
cur.execute("SELECT system_identifier::text FROM pg_control_system()")
return cur.fetchone()[0]
except (PostgresConnectionError, psycopg2.Error) as e:
_logger.debug(
"Error retrieving PostgreSQL system Id: %s", force_str(e).strip()
)
return None
def get_setting(self, name):
"""
Get a Postgres setting with a given name
:param name: a parameter name
"""
try:
cur = self._cursor()
cur.execute('SHOW "%s"' % name.replace('"', '""'))
return cur.fetchone()[0]
except (PostgresConnectionError, psycopg2.Error) as e:
_logger.debug(
"Error retrieving PostgreSQL setting '%s': %s",
name.replace('"', '""'),
force_str(e).strip(),
)
return None
def get_tablespaces(self):
"""
Returns a list of tablespaces or None if not present
"""
try:
cur = self._cursor()
if self.server_version >= 90200:
cur.execute(
"SELECT spcname, oid, "
"pg_tablespace_location(oid) AS spclocation "
"FROM pg_tablespace "
"WHERE pg_tablespace_location(oid) != ''"
)
else:
cur.execute(
"SELECT spcname, oid, spclocation "
"FROM pg_tablespace WHERE spclocation != ''"
)
# Generate a list of tablespace objects
return [Tablespace._make(item) for item in cur.fetchall()]
except (PostgresConnectionError, psycopg2.Error) as e:
_logger.debug(
"Error retrieving PostgreSQL tablespaces: %s", force_str(e).strip()
)
return None
def get_configuration_files(self):
"""
Get postgres configuration files or an empty dictionary
in case of error
:rtype: dict
"""
if self.configuration_files:
return self.configuration_files
try:
self.configuration_files = {}
cur = self._cursor()
cur.execute(
"SELECT name, setting FROM pg_settings "
"WHERE name IN ('config_file', 'hba_file', 'ident_file')"
)
for cname, cpath in cur.fetchall():
self.configuration_files[cname] = cpath
# Retrieve additional configuration files
# If PostgreSQL is older than 8.4 disable this check
if self.server_version >= 80400:
cur.execute(
"SELECT DISTINCT sourcefile AS included_file "
"FROM pg_settings "
"WHERE sourcefile IS NOT NULL "
"AND sourcefile NOT IN "
"(SELECT setting FROM pg_settings "
"WHERE name = 'config_file') "
"ORDER BY 1"
)
# Extract the values from the containing single element tuples
included_files = [included_file for included_file, in cur.fetchall()]
if len(included_files) > 0:
self.configuration_files["included_files"] = included_files
except (PostgresConnectionError, psycopg2.Error) as e:
_logger.debug(
"Error retrieving PostgreSQL configuration files location: %s",
force_str(e).strip(),
)
self.configuration_files = {}
return self.configuration_files
def create_restore_point(self, target_name):
"""
Create a restore point with the given target name
The method executes the pg_create_restore_point() function through
a PostgreSQL connection. Only for Postgres versions >= 9.1 when not
in replication.
If requirements are not met, the operation is skipped.
:param str target_name: name of the restore point
:returns: the restore point LSN
:rtype: str|None
"""
if self.server_version < 90100:
return None
# Not possible if on a standby
# Called inside the pg_connect context to reuse the connection
if self.is_in_recovery:
return None
try:
cur = self._cursor()
cur.execute("SELECT pg_create_restore_point(%s)", [target_name])
_logger.info("Restore point '%s' successfully created", target_name)
return cur.fetchone()[0]
except (PostgresConnectionError, psycopg2.Error) as e:
_logger.debug(
"Error issuing pg_create_restore_point() command: %s",
force_str(e).strip(),
)
return None
def start_exclusive_backup(self, label):
"""
Calls pg_start_backup() on the PostgreSQL server
This method returns a dictionary containing the following data:
* location
* file_name
* file_offset
* timestamp
:param str label: descriptive string to identify the backup
:rtype: psycopg2.extras.DictRow
"""
try:
conn = self.connect()
# Rollback to release the transaction, as the pg_start_backup
# invocation can last up to PostgreSQL's checkpoint_timeout
conn.rollback()
# Start an exclusive backup
cur = conn.cursor(cursor_factory=DictCursor)
if self.server_version < 80400:
cur.execute(
"SELECT location, "
"({pg_walfile_name_offset}(location)).*, "
"now() AS timestamp "
"FROM pg_start_backup(%s) AS location".format(**self.name_map),
(label,),
)
else:
cur.execute(
"SELECT location, "
"({pg_walfile_name_offset}(location)).*, "
"now() AS timestamp "
"FROM pg_start_backup(%s,%s) AS location".format(**self.name_map),
(label, self.immediate_checkpoint),
)
start_row = cur.fetchone()
# Rollback to release the transaction, as the connection
# is to be retained until the end of backup
conn.rollback()
return start_row
except (PostgresConnectionError, psycopg2.Error) as e:
msg = "pg_start_backup(): %s" % force_str(e).strip()
_logger.debug(msg)
raise PostgresException(msg)
def start_concurrent_backup(self, label):
"""
Calls pg_start_backup on the PostgreSQL server using the
API introduced with version 9.6
This method returns a dictionary containing the following data:
* location
* timeline
* timestamp
:param str label: descriptive string to identify the backup
:rtype: psycopg2.extras.DictRow
"""
try:
conn = self.connect()
# Rollback to release the transaction, as the pg_start_backup
# invocation can last up to PostgreSQL's checkpoint_timeout
conn.rollback()
# Start the backup using the api introduced in postgres 9.6
cur = conn.cursor(cursor_factory=DictCursor)
cur.execute(
"SELECT location, "
"(SELECT timeline_id "
"FROM pg_control_checkpoint()) AS timeline, "
"now() AS timestamp "
"FROM pg_start_backup(%s, %s, FALSE) AS location",
(label, self.immediate_checkpoint),
)
start_row = cur.fetchone()
# Rollback to release the transaction, as the connection
# is to be retained until the end of backup
conn.rollback()
return start_row
except (PostgresConnectionError, psycopg2.Error) as e:
msg = "pg_start_backup command: %s" % (force_str(e).strip(),)
_logger.debug(msg)
raise PostgresException(msg)
def stop_exclusive_backup(self):
"""
Calls pg_stop_backup() on the PostgreSQL server
This method returns a dictionary containing the following data:
* location
* file_name
* file_offset
* timestamp
:rtype: psycopg2.extras.DictRow
"""
try:
conn = self.connect()
# Rollback to release the transaction, as the pg_stop_backup
# invocation could will wait until the current WAL file is shipped
conn.rollback()
# Stop the backup
cur = conn.cursor(cursor_factory=DictCursor)
cur.execute(
"SELECT location, "
"({pg_walfile_name_offset}(location)).*, "
"now() AS timestamp "
"FROM pg_stop_backup() AS location".format(**self.name_map)
)
return cur.fetchone()
except (PostgresConnectionError, psycopg2.Error) as e:
msg = "Error issuing pg_stop_backup command: %s" % force_str(e).strip()
_logger.debug(msg)
raise PostgresException(
"Cannot terminate exclusive backup. "
"You might have to manually execute pg_stop_backup "
"on your PostgreSQL server"
)
def stop_concurrent_backup(self):
"""
Calls pg_stop_backup on the PostgreSQL server using the
API introduced with version 9.6
This method returns a dictionary containing the following data:
* location
* timeline
* backup_label
* timestamp
:rtype: psycopg2.extras.DictRow
"""
try:
conn = self.connect()
# Rollback to release the transaction, as the pg_stop_backup
# invocation could will wait until the current WAL file is shipped
conn.rollback()
# Stop the backup using the api introduced with version 9.6
cur = conn.cursor(cursor_factory=DictCursor)
cur.execute(
"SELECT end_row.lsn AS location, "
"(SELECT CASE WHEN pg_is_in_recovery() "
"THEN min_recovery_end_timeline ELSE timeline_id END "
"FROM pg_control_checkpoint(), pg_control_recovery()"
") AS timeline, "
"end_row.labelfile AS backup_label, "
"now() AS timestamp FROM pg_stop_backup(FALSE) AS end_row"
)
return cur.fetchone()
except (PostgresConnectionError, psycopg2.Error) as e:
msg = "Error issuing pg_stop_backup command: %s" % force_str(e).strip()
_logger.debug(msg)
raise PostgresException(msg)
def pgespresso_start_backup(self, label):
"""
Execute a pgespresso_start_backup
This method returns a dictionary containing the following data:
* backup_label
* timestamp
:param str label: descriptive string to identify the backup
:rtype: psycopg2.extras.DictRow
"""
try:
conn = self.connect()
# Rollback to release the transaction,
# as the pgespresso_start_backup invocation can last
# up to PostgreSQL's checkpoint_timeout
conn.rollback()
# Start the concurrent backup using pgespresso
cur = conn.cursor(cursor_factory=DictCursor)
cur.execute(
"SELECT pgespresso_start_backup(%s,%s) AS backup_label, "
"now() AS timestamp",
(label, self.immediate_checkpoint),
)
start_row = cur.fetchone()
# Rollback to release the transaction, as the connection
# is to be retained until the end of backup
conn.rollback()
return start_row
except (PostgresConnectionError, psycopg2.Error) as e:
msg = "pgespresso_start_backup(): %s" % force_str(e).strip()
_logger.debug(msg)
raise PostgresException(msg)
def pgespresso_stop_backup(self, backup_label):
"""
Execute a pgespresso_stop_backup
This method returns a dictionary containing the following data:
* end_wal
* timestamp
:param str backup_label: backup label as returned
by pgespress_start_backup
:rtype: psycopg2.extras.DictRow
"""
try:
conn = self.connect()
# Issue a rollback to release any unneeded lock
conn.rollback()
cur = conn.cursor(cursor_factory=DictCursor)
cur.execute(
"SELECT pgespresso_stop_backup(%s) AS end_wal, now() AS timestamp",
(backup_label,),
)
return cur.fetchone()
except (PostgresConnectionError, psycopg2.Error) as e:
msg = "Error issuing pgespresso_stop_backup() command: %s" % (
force_str(e).strip()
)
_logger.debug(msg)
raise PostgresException(
"%s\n"
"HINT: You might have to manually execute "
"pgespresso_abort_backup() on your PostgreSQL "
"server" % msg
)
def switch_wal(self):
"""
Execute a pg_switch_wal()
To be SURE of the switch of a xlog, we collect the xlogfile name
before and after the switch.
The method returns the just closed xlog file name if the current xlog
file has changed, it returns an empty string otherwise.
The method returns None if something went wrong during the execution
of the pg_switch_wal command.
:rtype: str|None
"""
try:
conn = self.connect()
if not self.has_backup_privileges:
raise BackupFunctionsAccessRequired(
"Postgres user '%s' is missing required privileges "
'(see "Preliminary steps" in the Barman manual)'
% self.conn_parameters.get("user")
)
# If this server is in recovery there is nothing to do
if self.is_in_recovery:
raise PostgresIsInRecovery()
cur = conn.cursor()
# Collect the xlog file name before the switch
cur.execute(
"SELECT {pg_walfile_name}("
"{pg_current_wal_insert_lsn}())".format(**self.name_map)
)
pre_switch = cur.fetchone()[0]
# Switch
cur.execute(
"SELECT {pg_walfile_name}({pg_switch_wal}())".format(**self.name_map)
)
# Collect the xlog file name after the switch
cur.execute(
"SELECT {pg_walfile_name}("
"{pg_current_wal_insert_lsn}())".format(**self.name_map)
)
post_switch = cur.fetchone()[0]
if pre_switch < post_switch:
return pre_switch
else:
return ""
except (PostgresConnectionError, psycopg2.Error) as e:
_logger.debug(
"Error issuing {pg_switch_wal}() command: %s".format(**self.name_map),
force_str(e).strip(),
)
return None
def checkpoint(self):
"""
Execute a checkpoint
"""
try:
conn = self.connect()
# Requires superuser privilege
if not self.is_superuser:
raise PostgresSuperuserRequired()
cur = conn.cursor()
cur.execute("CHECKPOINT")
except (PostgresConnectionError, psycopg2.Error) as e:
_logger.debug("Error issuing CHECKPOINT: %s", force_str(e).strip())
def get_replication_stats(self, client_type=STANDBY):
"""
Returns streaming replication information
"""
try:
cur = self._cursor(cursor_factory=NamedTupleCursor)
if not self.has_backup_privileges:
raise BackupFunctionsAccessRequired(
"Postgres user '%s' is missing required privileges "
'(see "Preliminary steps" in the Barman manual)'
% self.conn_parameters.get("user")
)
# pg_stat_replication is a system view that contains one
# row per WAL sender process with information about the
# replication status of a standby server. It has been
# introduced in PostgreSQL 9.1. Current fields are:
#
# - pid (procpid in 9.1)
# - usesysid
# - usename
# - application_name
# - client_addr
# - client_hostname
# - client_port
# - backend_start
# - backend_xmin (9.4+)
# - state
# - sent_lsn (sent_location before 10)
# - write_lsn (write_location before 10)
# - flush_lsn (flush_location before 10)
# - replay_lsn (replay_location before 10)
# - sync_priority
# - sync_state
#
if self.server_version < 90100:
raise PostgresUnsupportedFeature("9.1")
from_repslot = ""
where_clauses = []
if self.server_version >= 100000:
# Current implementation (10+)
what = "r.*, rs.slot_name"
# Look for replication slot name
from_repslot = (
"LEFT JOIN pg_replication_slots rs ON (r.pid = rs.active_pid) "
)
where_clauses += ["(rs.slot_type IS NULL OR rs.slot_type = 'physical')"]
elif self.server_version >= 90500:
# PostgreSQL 9.5/9.6
what = (
"pid, "
"usesysid, "
"usename, "
"application_name, "
"client_addr, "
"client_hostname, "
"client_port, "
"backend_start, "
"backend_xmin, "
"state, "
"sent_location AS sent_lsn, "
"write_location AS write_lsn, "
"flush_location AS flush_lsn, "
"replay_location AS replay_lsn, "
"sync_priority, "
"sync_state, "
"rs.slot_name"
)
# Look for replication slot name
from_repslot = (
"LEFT JOIN pg_replication_slots rs ON (r.pid = rs.active_pid) "
)
where_clauses += ["(rs.slot_type IS NULL OR rs.slot_type = 'physical')"]
elif self.server_version >= 90400:
# PostgreSQL 9.4
what = (
"pid, "
"usesysid, "
"usename, "
"application_name, "
"client_addr, "
"client_hostname, "
"client_port, "
"backend_start, "
"backend_xmin, "
"state, "
"sent_location AS sent_lsn, "
"write_location AS write_lsn, "
"flush_location AS flush_lsn, "
"replay_location AS replay_lsn, "
"sync_priority, "
"sync_state"
)
elif self.server_version >= 90200:
# PostgreSQL 9.2/9.3
what = (
"pid, "
"usesysid, "
"usename, "
"application_name, "
"client_addr, "
"client_hostname, "
"client_port, "
"backend_start, "
"CAST (NULL AS xid) AS backend_xmin, "
"state, "
"sent_location AS sent_lsn, "
"write_location AS write_lsn, "
"flush_location AS flush_lsn, "
"replay_location AS replay_lsn, "
"sync_priority, "
"sync_state"
)
else:
# PostgreSQL 9.1
what = (
"procpid AS pid, "
"usesysid, "
"usename, "
"application_name, "
"client_addr, "
"client_hostname, "
"client_port, "
"backend_start, "
"CAST (NULL AS xid) AS backend_xmin, "
"state, "
"sent_location AS sent_lsn, "
"write_location AS write_lsn, "
"flush_location AS flush_lsn, "
"replay_location AS replay_lsn, "
"sync_priority, "
"sync_state"
)
# Streaming client
if client_type == self.STANDBY:
# Standby server
where_clauses += ["{replay_lsn} IS NOT NULL".format(**self.name_map)]
elif client_type == self.WALSTREAMER:
# WAL streamer
where_clauses += ["{replay_lsn} IS NULL".format(**self.name_map)]
if where_clauses:
where = "WHERE %s " % " AND ".join(where_clauses)
else:
where = ""
# Execute the query
cur.execute(
"SELECT %s, "
"pg_is_in_recovery() AS is_in_recovery, "
"CASE WHEN pg_is_in_recovery() "
" THEN {pg_last_wal_receive_lsn}() "
" ELSE {pg_current_wal_lsn}() "
"END AS current_lsn "
"FROM pg_stat_replication r "
"%s"
"%s"
"ORDER BY sync_state DESC, sync_priority".format(**self.name_map)
% (what, from_repslot, where)
)
# Generate a list of standby objects
return cur.fetchall()
except (PostgresConnectionError, psycopg2.Error) as e:
_logger.debug(
"Error retrieving status of standby servers: %s", force_str(e).strip()
)
return None
def get_replication_slot(self, slot_name):
"""
Retrieve from the PostgreSQL server a physical replication slot
with a specific slot_name.
This method returns a dictionary containing the following data:
* slot_name
* active
* restart_lsn
:param str slot_name: the replication slot name
:rtype: psycopg2.extras.DictRow
"""
if self.server_version < 90400:
# Raise exception if replication slot are not supported
# by PostgreSQL version
raise PostgresUnsupportedFeature("9.4")
else:
cur = self._cursor(cursor_factory=NamedTupleCursor)
try:
cur.execute(
"SELECT slot_name, "
"active, "
"restart_lsn "
"FROM pg_replication_slots "
"WHERE slot_type = 'physical' "
"AND slot_name = '%s'" % slot_name
)
# Retrieve the replication slot information
return cur.fetchone()
except (PostgresConnectionError, psycopg2.Error) as e:
_logger.debug(
"Error retrieving replication_slots: %s", force_str(e).strip()
)
raise
def get_synchronous_standby_names(self):
"""
Retrieve the list of named synchronous standby servers from PostgreSQL
This method returns a list of names
:return list: synchronous standby names
"""
if self.server_version < 90100:
# Raise exception if synchronous replication is not supported
raise PostgresUnsupportedFeature("9.1")
else:
synchronous_standby_names = self.get_setting("synchronous_standby_names")
# Return empty list if not defined
if synchronous_standby_names is None:
return []
# Normalise the list of sync standby names
# On PostgreSQL 9.6 it is possible to specify the number of
# required synchronous standby using this format:
# n (name1, name2, ... nameN).
# We only need the name list, so we discard everything else.
# The name list starts after the first parenthesis or at pos 0
names_start = synchronous_standby_names.find("(") + 1
names_end = synchronous_standby_names.rfind(")")
if names_end < 0:
names_end = len(synchronous_standby_names)
names_list = synchronous_standby_names[names_start:names_end]
# We can blindly strip double quotes because PostgreSQL enforces
# the format of the synchronous_standby_names content
return [x.strip().strip('"') for x in names_list.split(",")]
@property
def name_map(self):
"""
Return a map with function and directory names according to the current
PostgreSQL version.
Each entry has the `current` name as key and the name for the specific
version as value.
:rtype: dict[str]
"""
# Avoid raising an error if the connection is not available
try:
server_version = self.server_version
except PostgresConnectionError:
_logger.debug(
"Impossible to detect the PostgreSQL version, "
"name_map will return names from latest version"
)
server_version = None
return function_name_map(server_version)
barman-2.18/barman/config.py 0000644 0006212 0006212 00000104335 14172556763 014165 0 ustar 0000000 0000000 # -*- coding: utf-8 -*-
# © Copyright EnterpriseDB UK Limited 2011-2022
#
# This file is part of Barman.
#
# Barman is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Barman is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Barman. If not, see .
"""
This module is responsible for all the things related to
Barman configuration, such as parsing configuration file.
"""
import collections
import datetime
import inspect
import logging.handlers
import os
import re
import sys
from glob import iglob
from barman import output
try:
from ConfigParser import ConfigParser, NoOptionError
except ImportError:
from configparser import ConfigParser, NoOptionError
# create a namedtuple object called PathConflict with 'label' and 'server'
PathConflict = collections.namedtuple("PathConflict", "label server")
_logger = logging.getLogger(__name__)
FORBIDDEN_SERVER_NAMES = ["all"]
DEFAULT_USER = "barman"
DEFAULT_LOG_LEVEL = logging.INFO
DEFAULT_LOG_FORMAT = "%(asctime)s [%(process)s] %(name)s %(levelname)s: %(message)s"
_TRUE_RE = re.compile(r"""^(true|t|yes|1|on)$""", re.IGNORECASE)
_FALSE_RE = re.compile(r"""^(false|f|no|0|off)$""", re.IGNORECASE)
_TIME_INTERVAL_RE = re.compile(
r"""
^\s*
# N (day|month|week|hour) with optional 's'
(\d+)\s+(day|month|week|hour)s?
\s*$
""",
re.IGNORECASE | re.VERBOSE,
)
_SLOT_NAME_RE = re.compile("^[0-9a-z_]+$")
_SI_SUFFIX_RE = re.compile(r"""(\d+)\s*(k|Ki|M|Mi|G|Gi|T|Ti)?\s*$""")
REUSE_BACKUP_VALUES = ("copy", "link", "off")
# Possible copy methods for backups (must be all lowercase)
BACKUP_METHOD_VALUES = ["rsync", "postgres", "local-rsync"]
CREATE_SLOT_VALUES = ["manual", "auto"]
class CsvOption(set):
"""
Base class for CSV options.
Given a comma delimited string, this class is a list containing the
submitted options.
Internally, it uses a set in order to avoid option replication.
Allowed values for the CSV option are contained in the 'value_list'
attribute.
The 'conflicts' attribute specifies for any value, the list of
values that are prohibited (and thus generate a conflict).
If a conflict is found, raises a ValueError exception.
"""
value_list = []
conflicts = {}
def __init__(self, value, key, source):
# Invoke parent class init and initialize an empty set
super(CsvOption, self).__init__()
# Parse not None values
if value is not None:
self.parse(value, key, source)
# Validates the object structure before returning the new instance
self.validate(key, source)
def parse(self, value, key, source):
"""
Parses a list of values and correctly assign the set of values
(removing duplication) and checking for conflicts.
"""
if not value:
return
values_list = value.split(",")
for val in sorted(values_list):
val = val.strip().lower()
if val in self.value_list:
# check for conflicting values. if a conflict is
# found the option is not valid then, raise exception.
if val in self.conflicts and self.conflicts[val] in self:
raise ValueError(
"Invalid configuration value '%s' for "
"key %s in %s: cannot contain both "
"'%s' and '%s'."
"Configuration directive ignored."
% (val, key, source, val, self.conflicts[val])
)
else:
# otherwise use parsed value
self.add(val)
else:
# not allowed value, reject the configuration
raise ValueError(
"Invalid configuration value '%s' for "
"key %s in %s: Unknown option" % (val, key, source)
)
def validate(self, key, source):
"""
Override this method for special validation needs
"""
def to_json(self):
"""
Output representation of the obj for JSON serialization
The result is a string which can be parsed by the same class
"""
return ",".join(self)
class BackupOptions(CsvOption):
"""
Extends CsvOption class providing all the details for the backup_options
field
"""
# constants containing labels for allowed values
EXCLUSIVE_BACKUP = "exclusive_backup"
CONCURRENT_BACKUP = "concurrent_backup"
EXTERNAL_CONFIGURATION = "external_configuration"
# list holding all the allowed values for the BackupOption class
value_list = [EXCLUSIVE_BACKUP, CONCURRENT_BACKUP, EXTERNAL_CONFIGURATION]
# map holding all the possible conflicts between the allowed values
conflicts = {
EXCLUSIVE_BACKUP: CONCURRENT_BACKUP,
CONCURRENT_BACKUP: EXCLUSIVE_BACKUP,
}
class RecoveryOptions(CsvOption):
"""
Extends CsvOption class providing all the details for the recovery_options
field
"""
# constants containing labels for allowed values
GET_WAL = "get-wal"
# list holding all the allowed values for the RecoveryOptions class
value_list = [GET_WAL]
def parse_boolean(value):
"""
Parse a string to a boolean value
:param str value: string representing a boolean
:raises ValueError: if the string is an invalid boolean representation
"""
if _TRUE_RE.match(value):
return True
if _FALSE_RE.match(value):
return False
raise ValueError("Invalid boolean representation (use 'true' or 'false')")
def parse_time_interval(value):
"""
Parse a string, transforming it in a time interval.
Accepted format: N (day|month|week)s
:param str value: the string to evaluate
"""
# if empty string or none return none
if value is None or value == "":
return None
result = _TIME_INTERVAL_RE.match(value)
# if the string doesn't match, the option is invalid
if not result:
raise ValueError("Invalid value for a time interval %s" % value)
# if the int conversion
value = int(result.groups()[0])
unit = result.groups()[1][0].lower()
# Calculates the time delta
if unit == "d":
time_delta = datetime.timedelta(days=value)
elif unit == "w":
time_delta = datetime.timedelta(weeks=value)
elif unit == "m":
time_delta = datetime.timedelta(days=(31 * value))
elif unit == "h":
time_delta = datetime.timedelta(hours=value)
else:
# This should never happen
raise ValueError("Invalid unit time %s" % unit)
return time_delta
def parse_si_suffix(value):
"""
Parse a string, transforming it into integer and multiplying by
the SI or IEC suffix
eg a suffix of Ki multiplies the integer value by 1024
and returns the new value
Accepted format: N (k|Ki|M|Mi|G|Gi|T|Ti)
:param str value: the string to evaluate
"""
# if empty string or none return none
if value is None or value == "":
return None
result = _SI_SUFFIX_RE.match(value)
if not result:
raise ValueError("Invalid value for a number %s" % value)
# if the int conversion
value = int(result.groups()[0])
unit = result.groups()[1]
# Calculates the value
if unit == "k":
value *= 1000
elif unit == "Ki":
value *= 1024
elif unit == "M":
value *= 1000000
elif unit == "Mi":
value *= 1048576
elif unit == "G":
value *= 1000000000
elif unit == "Gi":
value *= 1073741824
elif unit == "T":
value *= 1000000000000
elif unit == "Ti":
value *= 1099511627776
return value
def parse_reuse_backup(value):
"""
Parse a string to a valid reuse_backup value.
Valid values are "copy", "link" and "off"
:param str value: reuse_backup value
:raises ValueError: if the value is invalid
"""
if value is None:
return None
if value.lower() in REUSE_BACKUP_VALUES:
return value.lower()
raise ValueError(
"Invalid value (use '%s' or '%s')"
% ("', '".join(REUSE_BACKUP_VALUES[:-1]), REUSE_BACKUP_VALUES[-1])
)
def parse_backup_method(value):
"""
Parse a string to a valid backup_method value.
Valid values are contained in BACKUP_METHOD_VALUES list
:param str value: backup_method value
:raises ValueError: if the value is invalid
"""
if value is None:
return None
if value.lower() in BACKUP_METHOD_VALUES:
return value.lower()
raise ValueError(
"Invalid value (must be one in: '%s')" % ("', '".join(BACKUP_METHOD_VALUES))
)
def parse_slot_name(value):
"""
Replication slot names may only contain lower case letters, numbers,
and the underscore character. This function parse a replication slot name
:param str value: slot_name value
:return:
"""
if value is None:
return None
value = value.lower()
if not _SLOT_NAME_RE.match(value):
raise ValueError(
"Replication slot names may only contain lower case letters, "
"numbers, and the underscore character."
)
return value
def parse_create_slot(value):
"""
Parse a string to a valid create_slot value.
Valid values are "manual" and "auto"
:param str value: create_slot value
:raises ValueError: if the value is invalid
"""
if value is None:
return None
value = value.lower()
if value in CREATE_SLOT_VALUES:
return value
raise ValueError(
"Invalid value (use '%s' or '%s')"
% ("', '".join(CREATE_SLOT_VALUES[:-1]), CREATE_SLOT_VALUES[-1])
)
class ServerConfig(object):
"""
This class represents the configuration for a specific Server instance.
"""
KEYS = [
"active",
"archiver",
"archiver_batch_size",
"backup_directory",
"backup_method",
"backup_options",
"bandwidth_limit",
"basebackup_retry_sleep",
"basebackup_retry_times",
"basebackups_directory",
"check_timeout",
"compression",
"conninfo",
"custom_compression_filter",
"custom_decompression_filter",
"custom_compression_magic",
"description",
"disabled",
"errors_directory",
"forward_config_path",
"immediate_checkpoint",
"incoming_wals_directory",
"last_backup_maximum_age",
"last_backup_minimum_size",
"last_wal_maximum_age",
"max_incoming_wals_queue",
"minimum_redundancy",
"network_compression",
"parallel_jobs",
"path_prefix",
"post_archive_retry_script",
"post_archive_script",
"post_backup_retry_script",
"post_backup_script",
"post_delete_script",
"post_delete_retry_script",
"post_recovery_retry_script",
"post_recovery_script",
"post_wal_delete_script",
"post_wal_delete_retry_script",
"pre_archive_retry_script",
"pre_archive_script",
"pre_backup_retry_script",
"pre_backup_script",
"pre_delete_script",
"pre_delete_retry_script",
"pre_recovery_retry_script",
"pre_recovery_script",
"pre_wal_delete_script",
"pre_wal_delete_retry_script",
"primary_ssh_command",
"recovery_options",
"create_slot",
"retention_policy",
"retention_policy_mode",
"reuse_backup",
"slot_name",
"ssh_command",
"streaming_archiver",
"streaming_archiver_batch_size",
"streaming_archiver_name",
"streaming_backup_name",
"streaming_conninfo",
"streaming_wals_directory",
"tablespace_bandwidth_limit",
"wal_retention_policy",
"wals_directory",
]
BARMAN_KEYS = [
"archiver",
"archiver_batch_size",
"backup_method",
"backup_options",
"bandwidth_limit",
"basebackup_retry_sleep",
"basebackup_retry_times",
"check_timeout",
"compression",
"configuration_files_directory",
"custom_compression_filter",
"custom_decompression_filter",
"custom_compression_magic",
"forward_config_path",
"immediate_checkpoint",
"last_backup_maximum_age",
"last_backup_minimum_size",
"last_wal_maximum_age",
"max_incoming_wals_queue",
"minimum_redundancy",
"network_compression",
"parallel_jobs",
"path_prefix",
"post_archive_retry_script",
"post_archive_script",
"post_backup_retry_script",
"post_backup_script",
"post_delete_script",
"post_delete_retry_script",
"post_recovery_retry_script",
"post_recovery_script",
"post_wal_delete_script",
"post_wal_delete_retry_script",
"pre_archive_retry_script",
"pre_archive_script",
"pre_backup_retry_script",
"pre_backup_script",
"pre_delete_script",
"pre_delete_retry_script",
"pre_recovery_retry_script",
"pre_recovery_script",
"pre_wal_delete_script",
"pre_wal_delete_retry_script",
"primary_ssh_command",
"recovery_options",
"create_slot",
"retention_policy",
"retention_policy_mode",
"reuse_backup",
"slot_name",
"streaming_archiver",
"streaming_archiver_batch_size",
"streaming_archiver_name",
"streaming_backup_name",
"tablespace_bandwidth_limit",
"wal_retention_policy",
]
DEFAULTS = {
"active": "true",
"archiver": "off",
"archiver_batch_size": "0",
"backup_directory": "%(barman_home)s/%(name)s",
"backup_method": "rsync",
"backup_options": "",
"basebackup_retry_sleep": "30",
"basebackup_retry_times": "0",
"basebackups_directory": "%(backup_directory)s/base",
"check_timeout": "30",
"disabled": "false",
"errors_directory": "%(backup_directory)s/errors",
"forward_config_path": "false",
"immediate_checkpoint": "false",
"incoming_wals_directory": "%(backup_directory)s/incoming",
"minimum_redundancy": "0",
"network_compression": "false",
"parallel_jobs": "1",
"recovery_options": "",
"create_slot": "manual",
"retention_policy_mode": "auto",
"streaming_archiver": "off",
"streaming_archiver_batch_size": "0",
"streaming_archiver_name": "barman_receive_wal",
"streaming_backup_name": "barman_streaming_backup",
"streaming_conninfo": "%(conninfo)s",
"streaming_wals_directory": "%(backup_directory)s/streaming",
"wal_retention_policy": "main",
"wals_directory": "%(backup_directory)s/wals",
}
FIXED = [
"disabled",
]
PARSERS = {
"active": parse_boolean,
"archiver": parse_boolean,
"archiver_batch_size": int,
"backup_method": parse_backup_method,
"backup_options": BackupOptions,
"basebackup_retry_sleep": int,
"basebackup_retry_times": int,
"check_timeout": int,
"disabled": parse_boolean,
"forward_config_path": parse_boolean,
"immediate_checkpoint": parse_boolean,
"last_backup_maximum_age": parse_time_interval,
"last_backup_minimum_size": parse_si_suffix,
"last_wal_maximum_age": parse_time_interval,
"max_incoming_wals_queue": int,
"network_compression": parse_boolean,
"parallel_jobs": int,
"recovery_options": RecoveryOptions,
"create_slot": parse_create_slot,
"reuse_backup": parse_reuse_backup,
"streaming_archiver": parse_boolean,
"streaming_archiver_batch_size": int,
"slot_name": parse_slot_name,
}
def invoke_parser(self, key, source, value, new_value):
"""
Function used for parsing configuration values.
If needed, it uses special parsers from the PARSERS map,
and handles parsing exceptions.
Uses two values (value and new_value) to manage
configuration hierarchy (server config overwrites global config).
:param str key: the name of the configuration option
:param str source: the section that contains the configuration option
:param value: the old value of the option if present.
:param str new_value: the new value that needs to be parsed
:return: the parsed value of a configuration option
"""
# If the new value is None, returns the old value
if new_value is None:
return value
# If we have a parser for the current key, use it to obtain the
# actual value. If an exception is thrown, print a warning and
# ignore the value.
# noinspection PyBroadException
if key in self.PARSERS:
parser = self.PARSERS[key]
try:
# If the parser is a subclass of the CsvOption class
# we need a different invocation, which passes not only
# the value to the parser, but also the key name
# and the section that contains the configuration
if inspect.isclass(parser) and issubclass(parser, CsvOption):
value = parser(new_value, key, source)
else:
value = parser(new_value)
except Exception as e:
output.warning(
"Ignoring invalid configuration value '%s' for key %s in %s: %s",
new_value,
key,
source,
e,
)
else:
value = new_value
return value
def __init__(self, config, name):
self.msg_list = []
self.config = config
self.name = name
self.barman_home = config.barman_home
self.barman_lock_directory = config.barman_lock_directory
config.validate_server_config(self.name)
for key in ServerConfig.KEYS:
value = None
# Skip parameters that cannot be configured by users
if key not in ServerConfig.FIXED:
# Get the setting from the [name] section of config file
# A literal None value is converted to an empty string
new_value = config.get(name, key, self.__dict__, none_value="")
source = "[%s] section" % name
value = self.invoke_parser(key, source, value, new_value)
# If the setting isn't present in [name] section of config file
# check if it has to be inherited from the [barman] section
if value is None and key in ServerConfig.BARMAN_KEYS:
new_value = config.get("barman", key, self.__dict__, none_value="")
source = "[barman] section"
value = self.invoke_parser(key, source, value, new_value)
# If the setting isn't present in [name] section of config file
# and is not inherited from global section use its default
# (if present)
if value is None and key in ServerConfig.DEFAULTS:
new_value = ServerConfig.DEFAULTS[key] % self.__dict__
source = "DEFAULTS"
value = self.invoke_parser(key, source, value, new_value)
# An empty string is a None value (bypassing inheritance
# from global configuration)
if value is not None and value == "" or value == "None":
value = None
setattr(self, key, value)
def to_json(self):
"""
Return an equivalent dictionary that can be encoded in json
"""
json_dict = dict(vars(self))
# remove the reference to main Config object
del json_dict["config"]
return json_dict
def get_bwlimit(self, tablespace=None):
"""
Return the configured bandwidth limit for the provided tablespace
If tablespace is None, it returns the global bandwidth limit
:param barman.infofile.Tablespace tablespace: the tablespace to copy
:rtype: str
"""
# Default to global bandwidth limit
bwlimit = self.bandwidth_limit
if tablespace:
# A tablespace can be copied using a per-tablespace bwlimit
tbl_bw_limit = self.tablespace_bandwidth_limit
if tbl_bw_limit and tablespace.name in tbl_bw_limit:
bwlimit = tbl_bw_limit[tablespace.name]
return bwlimit
class Config(object):
"""This class represents the barman configuration.
Default configuration files are /etc/barman.conf,
/etc/barman/barman.conf
and ~/.barman.conf for a per-user configuration
"""
CONFIG_FILES = [
"~/.barman.conf",
"/etc/barman.conf",
"/etc/barman/barman.conf",
]
_QUOTE_RE = re.compile(r"""^(["'])(.*)\1$""")
def __init__(self, filename=None):
# In Python 3 ConfigParser has changed to be strict by default.
# Barman wants to preserve the Python 2 behavior, so we are
# explicitly building it passing strict=False.
try:
# Python 3.x
self._config = ConfigParser(strict=False)
except TypeError:
# Python 2.x
self._config = ConfigParser()
if filename:
if hasattr(filename, "read"):
try:
# Python 3.x
self._config.read_file(filename)
except AttributeError:
# Python 2.x
self._config.readfp(filename)
else:
# check for the existence of the user defined file
if not os.path.exists(filename):
sys.exit("Configuration file '%s' does not exist" % filename)
self._config.read(os.path.expanduser(filename))
else:
# Check for the presence of configuration files
# inside default directories
for path in self.CONFIG_FILES:
full_path = os.path.expanduser(path)
if os.path.exists(full_path) and full_path in self._config.read(
full_path
):
filename = full_path
break
else:
sys.exit(
"Could not find any configuration file at "
"default locations.\n"
"Check Barman's documentation for more help."
)
self.config_file = filename
self._servers = None
self.servers_msg_list = []
self._parse_global_config()
def get(self, section, option, defaults=None, none_value=None):
"""Method to get the value from a given section from
Barman configuration
"""
if not self._config.has_section(section):
return None
try:
value = self._config.get(section, option, raw=False, vars=defaults)
if value.lower() == "none":
value = none_value
if value is not None:
value = self._QUOTE_RE.sub(lambda m: m.group(2), value)
return value
except NoOptionError:
return None
def _parse_global_config(self):
"""
This method parses the global [barman] section
"""
self.barman_home = self.get("barman", "barman_home")
self.barman_lock_directory = (
self.get("barman", "barman_lock_directory") or self.barman_home
)
self.user = self.get("barman", "barman_user") or DEFAULT_USER
self.log_file = self.get("barman", "log_file")
self.log_format = self.get("barman", "log_format") or DEFAULT_LOG_FORMAT
self.log_level = self.get("barman", "log_level") or DEFAULT_LOG_LEVEL
# save the raw barman section to be compared later in
# _is_global_config_changed() method
self._global_config = set(self._config.items("barman"))
def _is_global_config_changed(self):
"""Return true if something has changed in global configuration"""
return self._global_config != set(self._config.items("barman"))
def load_configuration_files_directory(self):
"""
Read the "configuration_files_directory" option and load all the
configuration files with the .conf suffix that lie in that folder
"""
config_files_directory = self.get("barman", "configuration_files_directory")
if not config_files_directory:
return
if not os.path.isdir(os.path.expanduser(config_files_directory)):
_logger.warn(
'Ignoring the "configuration_files_directory" option as "%s" '
"is not a directory",
config_files_directory,
)
return
for cfile in sorted(
iglob(os.path.join(os.path.expanduser(config_files_directory), "*.conf"))
):
filename = os.path.basename(cfile)
if os.path.isfile(cfile):
# Load a file
_logger.debug("Including configuration file: %s", filename)
self._config.read(cfile)
if self._is_global_config_changed():
msg = (
"the configuration file %s contains a not empty ["
"barman] section" % filename
)
_logger.fatal(msg)
raise SystemExit("FATAL: %s" % msg)
else:
# Add an info that a file has been discarded
_logger.warn("Discarding configuration file: %s (not a file)", filename)
def _populate_servers(self):
"""
Populate server list from configuration file
Also check for paths errors in configuration.
If two or more paths overlap in
a single server, that server is disabled.
If two or more directory paths overlap between
different servers an error is raised.
"""
# Populate servers
if self._servers is not None:
return
self._servers = {}
# Cycle all the available configurations sections
for section in self._config.sections():
if section == "barman":
# skip global settings
continue
# Exit if the section has a reserved name
if section in FORBIDDEN_SERVER_NAMES:
msg = (
"the reserved word '%s' is not allowed as server name."
"Please rename it." % section
)
_logger.fatal(msg)
raise SystemExit("FATAL: %s" % msg)
# Create a ServerConfig object
self._servers[section] = ServerConfig(self, section)
# Check for conflicting paths in Barman configuration
self._check_conflicting_paths()
def _check_conflicting_paths(self):
"""
Look for conflicting paths intra-server and inter-server
"""
# All paths in configuration
servers_paths = {}
# Global errors list
self.servers_msg_list = []
# Cycle all the available configurations sections
for section in sorted(self._config.sections()):
if section == "barman":
# skip global settings
continue
# Paths map
section_conf = self._servers[section]
config_paths = {
"backup_directory": section_conf.backup_directory,
"basebackups_directory": section_conf.basebackups_directory,
"errors_directory": section_conf.errors_directory,
"incoming_wals_directory": section_conf.incoming_wals_directory,
"streaming_wals_directory": section_conf.streaming_wals_directory,
"wals_directory": section_conf.wals_directory,
}
# Check for path errors
for label, path in sorted(config_paths.items()):
# If the path does not conflict with the others, add it to the
# paths map
real_path = os.path.realpath(path)
if real_path not in servers_paths:
servers_paths[real_path] = PathConflict(label, section)
else:
if section == servers_paths[real_path].server:
# Internal path error.
# Insert the error message into the server.msg_list
if real_path == path:
self._servers[section].msg_list.append(
"Conflicting path: %s=%s conflicts with "
"'%s' for server '%s'"
% (
label,
path,
servers_paths[real_path].label,
servers_paths[real_path].server,
)
)
else:
# Symbolic link
self._servers[section].msg_list.append(
"Conflicting path: %s=%s (symlink to: %s) "
"conflicts with '%s' for server '%s'"
% (
label,
path,
real_path,
servers_paths[real_path].label,
servers_paths[real_path].server,
)
)
# Disable the server
self._servers[section].disabled = True
else:
# Global path error.
# Insert the error message into the global msg_list
if real_path == path:
self.servers_msg_list.append(
"Conflicting path: "
"%s=%s for server '%s' conflicts with "
"'%s' for server '%s'"
% (
label,
path,
section,
servers_paths[real_path].label,
servers_paths[real_path].server,
)
)
else:
# Symbolic link
self.servers_msg_list.append(
"Conflicting path: "
"%s=%s (symlink to: %s) for server '%s' "
"conflicts with '%s' for server '%s'"
% (
label,
path,
real_path,
section,
servers_paths[real_path].label,
servers_paths[real_path].server,
)
)
def server_names(self):
"""This method returns a list of server names"""
self._populate_servers()
return self._servers.keys()
def servers(self):
"""This method returns a list of server parameters"""
self._populate_servers()
return self._servers.values()
def get_server(self, name):
"""
Get the configuration of the specified server
:param str name: the server name
"""
self._populate_servers()
return self._servers.get(name, None)
def validate_global_config(self):
"""
Validate global configuration parameters
"""
# Check for the existence of unexpected parameters in the
# global section of the configuration file
keys = [
"barman_home",
"barman_lock_directory",
"barman_user",
"log_file",
"log_level",
"configuration_files_directory",
]
keys.extend(ServerConfig.KEYS)
self._validate_with_keys(self._global_config, keys, "barman")
def validate_server_config(self, server):
"""
Validate configuration parameters for a specified server
:param str server: the server name
"""
# Check for the existence of unexpected parameters in the
# server section of the configuration file
self._validate_with_keys(self._config.items(server), ServerConfig.KEYS, server)
@staticmethod
def _validate_with_keys(config_items, allowed_keys, section):
"""
Check every config parameter against a list of allowed keys
:param config_items: list of tuples containing provided parameters
along with their values
:param allowed_keys: list of allowed keys
:param section: source section (for error reporting)
"""
for parameter in config_items:
# if the parameter name is not in the list of allowed values,
# then output a warning
name = parameter[0]
if name not in allowed_keys:
output.warning(
'Invalid configuration option "%s" in [%s] ' "section.",
name,
section,
)
# easy raw config diagnostic with python -m
# noinspection PyProtectedMember
def _main():
print("Active configuration settings:")
r = Config()
r.load_configuration_files_directory()
for section in r._config.sections():
print("Section: %s" % section)
for option in r._config.options(section):
print("\t%s = %s " % (option, r.get(section, option)))
if __name__ == "__main__":
_main()
barman-2.18/barman/version.py 0000644 0006212 0006212 00000001444 14172556766 014405 0 ustar 0000000 0000000 # -*- coding: utf-8 -*-
# © Copyright EnterpriseDB UK Limited 2011-2022
#
# This file is part of Barman.
#
# Barman is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Barman is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Barman. If not, see .
"""
This module contains the current Barman version.
"""
__version__ = '2.18'
barman-2.18/barman/__init__.py 0000644 0006212 0006212 00000001572 14172556763 014456 0 ustar 0000000 0000000 # -*- coding: utf-8 -*-
# © Copyright EnterpriseDB UK Limited 2011-2022
#
# This file is part of Barman.
#
# Barman is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Barman is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Barman. If not, see .
"""
The main Barman module
"""
from __future__ import absolute_import
from .version import __version__
__config__ = None
__all__ = ["__version__", "__config__"]
barman-2.18/barman/backup.py 0000644 0006212 0006212 00000163547 14172556763 014177 0 ustar 0000000 0000000 # -*- coding: utf-8 -*-
# © Copyright EnterpriseDB UK Limited 2011-2022
#
# This file is part of Barman.
#
# Barman is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Barman is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Barman. If not, see .
"""
This module represents a backup.
"""
import datetime
import logging
import os
import shutil
import tempfile
from contextlib import closing
from glob import glob
import dateutil.parser
import dateutil.tz
from barman import output, xlog
from barman.annotations import KeepManager, KeepManagerMixin
from barman.backup_executor import (
PassiveBackupExecutor,
PostgresBackupExecutor,
RsyncBackupExecutor,
)
from barman.compression import CompressionManager
from barman.config import BackupOptions
from barman.exceptions import (
AbortedRetryHookScript,
CompressionIncompatibility,
SshCommandException,
UnknownBackupIdException,
CommandFailedException,
)
from barman.hooks import HookScriptRunner, RetryHookScriptRunner
from barman.infofile import BackupInfo, LocalBackupInfo, WalFileInfo
from barman.lockfile import ServerBackupSyncLock
from barman.recovery_executor import RecoveryExecutor
from barman.remote_status import RemoteStatusMixin
from barman.utils import (
force_str,
fsync_dir,
fsync_file,
human_readable_timedelta,
pretty_size,
)
from barman.command_wrappers import PgVerifyBackup
_logger = logging.getLogger(__name__)
class BackupManager(RemoteStatusMixin, KeepManagerMixin):
"""Manager of the backup archive for a server"""
DEFAULT_STATUS_FILTER = BackupInfo.STATUS_COPY_DONE
def __init__(self, server):
"""
Constructor
:param server: barman.server.Server
"""
super(BackupManager, self).__init__(server=server)
self.server = server
self.config = server.config
self._backup_cache = None
self.compression_manager = CompressionManager(self.config, server.path)
self.executor = None
try:
if server.passive_node:
self.executor = PassiveBackupExecutor(self)
elif self.config.backup_method == "postgres":
self.executor = PostgresBackupExecutor(self)
elif self.config.backup_method == "local-rsync":
self.executor = RsyncBackupExecutor(self, local_mode=True)
else:
self.executor = RsyncBackupExecutor(self)
except SshCommandException as e:
self.config.disabled = True
self.config.msg_list.append(force_str(e).strip())
@property
def mode(self):
"""
Property defining the BackupInfo mode content
"""
if self.executor:
return self.executor.mode
return None
def get_available_backups(self, status_filter=DEFAULT_STATUS_FILTER):
"""
Get a list of available backups
:param status_filter: default DEFAULT_STATUS_FILTER. The status of
the backup list returned
"""
# If the filter is not a tuple, create a tuple using the filter
if not isinstance(status_filter, tuple):
status_filter = tuple(
status_filter,
)
# Load the cache if necessary
if self._backup_cache is None:
self._load_backup_cache()
# Filter the cache using the status filter tuple
backups = {}
for key, value in self._backup_cache.items():
if value.status in status_filter:
backups[key] = value
return backups
def _load_backup_cache(self):
"""
Populate the cache of the available backups, reading information
from disk.
"""
self._backup_cache = {}
# Load all the backups from disk reading the backup.info files
for filename in glob("%s/*/backup.info" % self.config.basebackups_directory):
backup = LocalBackupInfo(self.server, filename)
self._backup_cache[backup.backup_id] = backup
def backup_cache_add(self, backup_info):
"""
Register a BackupInfo object to the backup cache.
NOTE: Initialise the cache - in case it has not been done yet
:param barman.infofile.BackupInfo backup_info: the object we want to
register in the cache
"""
# Load the cache if needed
if self._backup_cache is None:
self._load_backup_cache()
# Insert the BackupInfo object into the cache
self._backup_cache[backup_info.backup_id] = backup_info
def backup_cache_remove(self, backup_info):
"""
Remove a BackupInfo object from the backup cache
This method _must_ be called after removing the object from disk.
:param barman.infofile.BackupInfo backup_info: the object we want to
remove from the cache
"""
# Nothing to do if the cache is not loaded
if self._backup_cache is None:
return
# Remove the BackupInfo object from the backups cache
del self._backup_cache[backup_info.backup_id]
def get_backup(self, backup_id):
"""
Return the backup information for the given backup id.
If the backup_id is None or backup.info file doesn't exists,
it returns None.
:param str|None backup_id: the ID of the backup to return
:rtype: BackupInfo|None
"""
if backup_id is not None:
# Get all the available backups from the cache
available_backups = self.get_available_backups(BackupInfo.STATUS_ALL)
# Return the BackupInfo if present, or None
return available_backups.get(backup_id)
return None
@staticmethod
def find_previous_backup_in(
available_backups, backup_id, status_filter=DEFAULT_STATUS_FILTER
):
"""
Find the next backup (if any) in the supplied dict of BackupInfo objects.
"""
ids = sorted(available_backups.keys())
try:
current = ids.index(backup_id)
while current > 0:
res = available_backups[ids[current - 1]]
if res.status in status_filter:
return res
current -= 1
return None
except ValueError:
raise UnknownBackupIdException("Could not find backup_id %s" % backup_id)
def get_previous_backup(self, backup_id, status_filter=DEFAULT_STATUS_FILTER):
"""
Get the previous backup (if any) in the catalog
:param status_filter: default DEFAULT_STATUS_FILTER. The status of
the backup returned
"""
if not isinstance(status_filter, tuple):
status_filter = tuple(status_filter)
backup = LocalBackupInfo(self.server, backup_id=backup_id)
available_backups = self.get_available_backups(status_filter + (backup.status,))
return self.find_previous_backup_in(available_backups, backup_id, status_filter)
@staticmethod
def should_remove_wals(
backup,
available_backups,
keep_manager,
skip_wal_cleanup_if_standalone,
status_filter=DEFAULT_STATUS_FILTER,
):
"""
Determine whether we should remove the WALs for the specified backup.
Returns the following tuple:
- `(bool should_remove_wals, list wal_ranges_to_protect)`
Where `should_remove_wals` is a boolean which is True if the WALs associated
with this backup should be removed and False otherwise.
`wal_ranges_to_protect` is a list of `(begin_wal, end_wal)` tuples which define
*inclusive* ranges where any matching WAL should not be deleted.
The rules for determining whether we should remove WALs are as follows:
1. If there is no previous backup then we can clean up the WALs.
2. If there is a previous backup and it has no keep annotation then do
not clean up the WALs. We need to allow PITR from that older backup
to the current time.
3. If there is a previous backup and it has a keep target of "full" then
do nothing. We need to allow PITR from that keep:full backup to the
current time.
4. If there is a previous backup and it has a keep target of "standalone":
a. If that previous backup is the oldest backup then delete WALs up to
the begin_wal of the next backup except for WALs which are
>= begin_wal and <= end_wal of the keep:standalone backup - we can
therefore add `(begin_wal, end_wal)` to `wal_ranges_to_protect` and
return True.
b. If that previous backup is not the oldest backup then we add the
`(begin_wal, end_wal)` to `wal_ranges_to_protect` and go to 2 above.
We will either end up returning False, because we hit a backup with
keep:full or no keep annotation, or all backups to the oldest backup
will be keep:standalone in which case we will delete up to the
begin_wal of the next backup, preserving the WALs needed by each
keep:standalone backups by adding them to `wal_ranges_to_protect`.
This is a static method so it can be re-used by barman-cloud which will
pass in its own dict of available_backups.
:param BackupInfo backup_info: The backup for which we are determining
whether we can clean up WALs.
:param dict[str,BackupInfo] available_backups: A dict of BackupInfo
objects keyed by backup_id which represent all available backups for
the current server.
:param KeepManagerMixin keep_manager: An object implementing the
KeepManagerMixin interface. This will be either a BackupManager (in
barman) or a CloudBackupCatalog (in barman-cloud).
:param bool skip_wal_cleanup_if_standalone: If set to True then we should
skip removing WALs for cases where all previous backups are standalone
archival backups (i.e. they have a keep annotation of "standalone").
The default is True. It is only safe to set this to False if the backup
is being deleted due to a retention policy rather than a `barman delete`
command.
:param status_filter: The status of the backups to check when determining
if we should remove WALs. default to DEFAULT_STATUS_FILTER.
"""
previous_backup = BackupManager.find_previous_backup_in(
available_backups, backup.backup_id, status_filter=status_filter
)
wal_ranges_to_protect = []
while True:
if previous_backup is None:
# No previous backup so we should remove WALs and return any WAL ranges
# we have found so far
return True, wal_ranges_to_protect
elif (
keep_manager.get_keep_target(previous_backup.backup_id)
== KeepManager.TARGET_STANDALONE
):
# A previous backup exists and it is a standalone backup - if we have
# been asked to skip wal cleanup on standalone backups then we
# should not remove wals
if skip_wal_cleanup_if_standalone:
return False, []
# Otherwise we add to the WAL ranges to protect
wal_ranges_to_protect.append(
(previous_backup.begin_wal, previous_backup.end_wal)
)
# and continue iterating through previous backups until we find either
# no previous backup or a non-standalone backup
previous_backup = BackupManager.find_previous_backup_in(
available_backups,
previous_backup.backup_id,
status_filter=status_filter,
)
continue
else:
# A previous backup exists and it is not a standalone backup so we
# must not remove any WALs and we can discard any wal_ranges_to_protect
# since they are no longer relevant
return False, []
@staticmethod
def find_next_backup_in(
available_backups, backup_id, status_filter=DEFAULT_STATUS_FILTER
):
"""
Find the next backup (if any) in the supplied dict of BackupInfo objects.
"""
ids = sorted(available_backups.keys())
try:
current = ids.index(backup_id)
while current < (len(ids) - 1):
res = available_backups[ids[current + 1]]
if res.status in status_filter:
return res
current += 1
return None
except ValueError:
raise UnknownBackupIdException("Could not find backup_id %s" % backup_id)
def get_next_backup(self, backup_id, status_filter=DEFAULT_STATUS_FILTER):
"""
Get the next backup (if any) in the catalog
:param status_filter: default DEFAULT_STATUS_FILTER. The status of
the backup returned
"""
if not isinstance(status_filter, tuple):
status_filter = tuple(status_filter)
backup = LocalBackupInfo(self.server, backup_id=backup_id)
available_backups = self.get_available_backups(status_filter + (backup.status,))
return self.find_next_backup_in(available_backups, backup_id, status_filter)
def get_last_backup_id(self, status_filter=DEFAULT_STATUS_FILTER):
"""
Get the id of the latest/last backup in the catalog (if exists)
:param status_filter: The status of the backup to return,
default to DEFAULT_STATUS_FILTER.
:return string|None: ID of the backup
"""
available_backups = self.get_available_backups(status_filter)
if len(available_backups) == 0:
return None
ids = sorted(available_backups.keys())
return ids[-1]
def get_first_backup_id(self, status_filter=DEFAULT_STATUS_FILTER):
"""
Get the id of the oldest/first backup in the catalog (if exists)
:param status_filter: The status of the backup to return,
default to DEFAULT_STATUS_FILTER.
:return string|None: ID of the backup
"""
available_backups = self.get_available_backups(status_filter)
if len(available_backups) == 0:
return None
ids = sorted(available_backups.keys())
return ids[0]
@staticmethod
def get_timelines_to_protect(remove_until, deleted_backup, available_backups):
"""
Returns all timelines in available_backups which are not associated with
the backup at remove_until. This is so that we do not delete WALs on
any other timelines.
"""
timelines_to_protect = set()
# If remove_until is not set there are no backup left
if remove_until:
# Retrieve the list of extra timelines that contains at least
# a backup. On such timelines we don't want to delete any WAL
for value in available_backups.values():
# Ignore the backup that is being deleted
if value == deleted_backup:
continue
timelines_to_protect.add(value.timeline)
# Remove the timeline of `remove_until` from the list.
# We have enough information to safely delete unused WAL files
# on it.
timelines_to_protect -= set([remove_until.timeline])
return timelines_to_protect
def delete_backup(self, backup, skip_wal_cleanup_if_standalone=True):
"""
Delete a backup
:param backup: the backup to delete
:param bool skip_wal_cleanup_if_standalone: By default we will skip removing
WALs if the oldest backups are standalong archival backups (i.e. they have
a keep annotation of "standalone"). If this function is being called in the
context of a retention policy however, it is safe to set
skip_wal_cleanup_if_standalone to False and clean up WALs associated with those
backups.
:return bool: True if deleted, False if could not delete the backup
"""
if self.should_keep_backup(backup.backup_id):
output.warning(
"Skipping delete of backup %s for server %s "
"as it has a current keep request. If you really "
"want to delete this backup please remove the keep "
"and try again.",
backup.backup_id,
self.config.name,
)
return False
available_backups = self.get_available_backups(status_filter=(BackupInfo.DONE,))
minimum_redundancy = self.server.config.minimum_redundancy
# Honour minimum required redundancy
if backup.status == BackupInfo.DONE and minimum_redundancy >= len(
available_backups
):
output.warning(
"Skipping delete of backup %s for server %s "
"due to minimum redundancy requirements "
"(minimum redundancy = %s, "
"current redundancy = %s)",
backup.backup_id,
self.config.name,
minimum_redundancy,
len(available_backups),
)
return False
# Keep track of when the delete operation started.
delete_start_time = datetime.datetime.now()
# Run the pre_delete_script if present.
script = HookScriptRunner(self, "delete_script", "pre")
script.env_from_backup_info(backup)
script.run()
# Run the pre_delete_retry_script if present.
retry_script = RetryHookScriptRunner(self, "delete_retry_script", "pre")
retry_script.env_from_backup_info(backup)
retry_script.run()
output.info(
"Deleting backup %s for server %s", backup.backup_id, self.config.name
)
should_remove_wals, wal_ranges_to_protect = BackupManager.should_remove_wals(
backup,
self.get_available_backups(
BackupManager.DEFAULT_STATUS_FILTER + (backup.status,)
),
keep_manager=self,
skip_wal_cleanup_if_standalone=skip_wal_cleanup_if_standalone,
)
next_backup = self.get_next_backup(backup.backup_id)
# Delete all the data contained in the backup
try:
self.delete_backup_data(backup)
except OSError as e:
output.error(
"Failure deleting backup %s for server %s.\n%s",
backup.backup_id,
self.config.name,
e,
)
return False
if should_remove_wals:
# There is no previous backup or all previous backups are archival
# standalone backups, so we can remove unused WALs (those WALs not
# required by standalone archival backups).
# If there is a next backup then all unused WALs up to the begin_wal
# of the next backup can be removed.
# If there is no next backup then there are no remaining backups so:
# - In the case of exclusive backup (default), remove all unused
# WAL files.
# - In the case of concurrent backup, removes only unused WAL files
# prior to the start of the backup being deleted, as they
# might be useful to any concurrent backup started immediately
# after.
remove_until = None # means to remove all WAL files
if next_backup:
remove_until = next_backup
elif BackupOptions.CONCURRENT_BACKUP in self.config.backup_options:
remove_until = backup
timelines_to_protect = self.get_timelines_to_protect(
remove_until,
backup,
self.get_available_backups(BackupInfo.STATUS_ARCHIVING),
)
output.info("Delete associated WAL segments:")
for name in self.remove_wal_before_backup(
remove_until, timelines_to_protect, wal_ranges_to_protect
):
output.info("\t%s", name)
# As last action, remove the backup directory,
# ending the delete operation
try:
self.delete_basebackup(backup)
except OSError as e:
output.error(
"Failure deleting backup %s for server %s.\n%s\n"
"Please manually remove the '%s' directory",
backup.backup_id,
self.config.name,
e,
backup.get_basebackup_directory(),
)
return False
self.backup_cache_remove(backup)
# Save the time of the complete removal of the backup
delete_end_time = datetime.datetime.now()
output.info(
"Deleted backup %s (start time: %s, elapsed time: %s)",
backup.backup_id,
delete_start_time.ctime(),
human_readable_timedelta(delete_end_time - delete_start_time),
)
# Remove the sync lockfile if exists
sync_lock = ServerBackupSyncLock(
self.config.barman_lock_directory, self.config.name, backup.backup_id
)
if os.path.exists(sync_lock.filename):
_logger.debug("Deleting backup sync lockfile: %s" % sync_lock.filename)
os.unlink(sync_lock.filename)
# Run the post_delete_retry_script if present.
try:
retry_script = RetryHookScriptRunner(self, "delete_retry_script", "post")
retry_script.env_from_backup_info(backup)
retry_script.run()
except AbortedRetryHookScript as e:
# Ignore the ABORT_STOP as it is a post-hook operation
_logger.warning(
"Ignoring stop request after receiving "
"abort (exit code %d) from post-delete "
"retry hook script: %s",
e.hook.exit_status,
e.hook.script,
)
# Run the post_delete_script if present.
script = HookScriptRunner(self, "delete_script", "post")
script.env_from_backup_info(backup)
script.run()
return True
def backup(self, wait=False, wait_timeout=None):
"""
Performs a backup for the server
:param bool wait: wait for all the required WAL files to be archived
:param int|None wait_timeout:
:return BackupInfo: the generated BackupInfo
"""
_logger.debug("initialising backup information")
self.executor.init()
backup_info = None
try:
# Create the BackupInfo object representing the backup
backup_info = LocalBackupInfo(
self.server, backup_id=datetime.datetime.now().strftime("%Y%m%dT%H%M%S")
)
backup_info.set_attribute("systemid", self.server.systemid)
backup_info.save()
self.backup_cache_add(backup_info)
output.info(
"Starting backup using %s method for server %s in %s",
self.mode,
self.config.name,
backup_info.get_basebackup_directory(),
)
# Run the pre-backup-script if present.
script = HookScriptRunner(self, "backup_script", "pre")
script.env_from_backup_info(backup_info)
script.run()
# Run the pre-backup-retry-script if present.
retry_script = RetryHookScriptRunner(self, "backup_retry_script", "pre")
retry_script.env_from_backup_info(backup_info)
retry_script.run()
# Do the backup using the BackupExecutor
self.executor.backup(backup_info)
# Create a restore point after a backup
target_name = "barman_%s" % backup_info.backup_id
self.server.postgres.create_restore_point(target_name)
# Free the Postgres connection
self.server.postgres.close()
# Compute backup size and fsync it on disk
self.backup_fsync_and_set_sizes(backup_info)
# Mark the backup as WAITING_FOR_WALS
backup_info.set_attribute("status", BackupInfo.WAITING_FOR_WALS)
# Use BaseException instead of Exception to catch events like
# KeyboardInterrupt (e.g.: CTRL-C)
except BaseException as e:
msg_lines = force_str(e).strip().splitlines()
# If the exception has no attached message use the raw
# type name
if len(msg_lines) == 0:
msg_lines = [type(e).__name__]
if backup_info:
# Use only the first line of exception message
# in backup_info error field
backup_info.set_attribute("status", BackupInfo.FAILED)
backup_info.set_attribute(
"error",
"failure %s (%s)" % (self.executor.current_action, msg_lines[0]),
)
output.error(
"Backup failed %s.\nDETAILS: %s",
self.executor.current_action,
"\n".join(msg_lines),
)
else:
output.info(
"Backup end at LSN: %s (%s, %08X)",
backup_info.end_xlog,
backup_info.end_wal,
backup_info.end_offset,
)
executor = self.executor
output.info(
"Backup completed (start time: %s, elapsed time: %s)",
self.executor.copy_start_time,
human_readable_timedelta(
datetime.datetime.now() - executor.copy_start_time
),
)
# If requested, wait for end_wal to be archived
if wait:
try:
self.server.wait_for_wal(backup_info.end_wal, wait_timeout)
self.check_backup(backup_info)
except KeyboardInterrupt:
# Ignore CTRL-C pressed while waiting for WAL files
output.info(
"Got CTRL-C. Continuing without waiting for '%s' "
"to be archived",
backup_info.end_wal,
)
finally:
if backup_info:
backup_info.save()
# Make sure we are not holding any PostgreSQL connection
# during the post-backup scripts
self.server.close()
# Run the post-backup-retry-script if present.
try:
retry_script = RetryHookScriptRunner(
self, "backup_retry_script", "post"
)
retry_script.env_from_backup_info(backup_info)
retry_script.run()
except AbortedRetryHookScript as e:
# Ignore the ABORT_STOP as it is a post-hook operation
_logger.warning(
"Ignoring stop request after receiving "
"abort (exit code %d) from post-backup "
"retry hook script: %s",
e.hook.exit_status,
e.hook.script,
)
# Run the post-backup-script if present.
script = HookScriptRunner(self, "backup_script", "post")
script.env_from_backup_info(backup_info)
script.run()
output.result("backup", backup_info)
return backup_info
def recover(
self, backup_info, dest, tablespaces=None, remote_command=None, **kwargs
):
"""
Performs a recovery of a backup
:param barman.infofile.LocalBackupInfo backup_info: the backup
to recover
:param str dest: the destination directory
:param dict[str,str]|None tablespaces: a tablespace name -> location
map (for relocation)
:param str|None remote_command: default None. The remote command
to recover the base backup, in case of remote backup.
:kwparam str|None target_tli: the target timeline
:kwparam str|None target_time: the target time
:kwparam str|None target_xid: the target xid
:kwparam str|None target_lsn: the target LSN
:kwparam str|None target_name: the target name created previously with
pg_create_restore_point() function call
:kwparam bool|None target_immediate: end recovery as soon as
consistency is reached
:kwparam bool exclusive: whether the recovery is exclusive or not
:kwparam str|None target_action: default None. The recovery target
action
:kwparam bool|None standby_mode: the standby mode if needed
"""
# Archive every WAL files in the incoming directory of the server
self.server.archive_wal(verbose=False)
# Delegate the recovery operation to a RecoveryExecutor object
executor = RecoveryExecutor(self)
# Run the pre_recovery_script if present.
script = HookScriptRunner(self, "recovery_script", "pre")
script.env_from_recover(
backup_info, dest, tablespaces, remote_command, **kwargs
)
script.run()
# Run the pre_recovery_retry_script if present.
retry_script = RetryHookScriptRunner(self, "recovery_retry_script", "pre")
retry_script.env_from_recover(
backup_info, dest, tablespaces, remote_command, **kwargs
)
retry_script.run()
# Execute the recovery.
# We use a closing context to automatically remove
# any resource eventually allocated during recovery.
with closing(executor):
recovery_info = executor.recover(
backup_info,
dest,
tablespaces=tablespaces,
remote_command=remote_command,
**kwargs
)
# Run the post_recovery_retry_script if present.
try:
retry_script = RetryHookScriptRunner(self, "recovery_retry_script", "post")
retry_script.env_from_recover(
backup_info, dest, tablespaces, remote_command, **kwargs
)
retry_script.run()
except AbortedRetryHookScript as e:
# Ignore the ABORT_STOP as it is a post-hook operation
_logger.warning(
"Ignoring stop request after receiving "
"abort (exit code %d) from post-recovery "
"retry hook script: %s",
e.hook.exit_status,
e.hook.script,
)
# Run the post-recovery-script if present.
script = HookScriptRunner(self, "recovery_script", "post")
script.env_from_recover(
backup_info, dest, tablespaces, remote_command, **kwargs
)
script.run()
# Output recovery results
output.result("recovery", recovery_info["results"])
def archive_wal(self, verbose=True):
"""
Executes WAL maintenance operations, such as archiving and compression
If verbose is set to False, outputs something only if there is
at least one file
:param bool verbose: report even if no actions
"""
for archiver in self.server.archivers:
archiver.archive(verbose)
def cron_retention_policy(self):
"""
Retention policy management
"""
enforce_retention_policies = self.server.enforce_retention_policies
retention_policy_mode = self.config.retention_policy_mode
if enforce_retention_policies and retention_policy_mode == "auto":
available_backups = self.get_available_backups(BackupInfo.STATUS_ALL)
retention_status = self.config.retention_policy.report()
for bid in sorted(retention_status.keys()):
if retention_status[bid] == BackupInfo.OBSOLETE:
output.info(
"Enforcing retention policy: removing backup %s for "
"server %s" % (bid, self.config.name)
)
self.delete_backup(
available_backups[bid], skip_wal_cleanup_if_standalone=False
)
def delete_basebackup(self, backup):
"""
Delete the basebackup dir of a given backup.
:param barman.infofile.LocalBackupInfo backup: the backup to delete
"""
backup_dir = backup.get_basebackup_directory()
_logger.debug("Deleting base backup directory: %s" % backup_dir)
shutil.rmtree(backup_dir)
def delete_backup_data(self, backup):
"""
Delete the data contained in a given backup.
:param barman.infofile.LocalBackupInfo backup: the backup to delete
"""
if backup.tablespaces:
if backup.backup_version == 2:
tbs_dir = backup.get_basebackup_directory()
else:
tbs_dir = os.path.join(backup.get_data_directory(), "pg_tblspc")
for tablespace in backup.tablespaces:
rm_dir = os.path.join(tbs_dir, str(tablespace.oid))
if os.path.exists(rm_dir):
_logger.debug(
"Deleting tablespace %s directory: %s"
% (tablespace.name, rm_dir)
)
shutil.rmtree(rm_dir)
pg_data = backup.get_data_directory()
if os.path.exists(pg_data):
_logger.debug("Deleting PGDATA directory: %s" % pg_data)
shutil.rmtree(pg_data)
def delete_wal(self, wal_info):
"""
Delete a WAL segment, with the given WalFileInfo
:param barman.infofile.WalFileInfo wal_info: the WAL to delete
"""
# Run the pre_wal_delete_script if present.
script = HookScriptRunner(self, "wal_delete_script", "pre")
script.env_from_wal_info(wal_info)
script.run()
# Run the pre_wal_delete_retry_script if present.
retry_script = RetryHookScriptRunner(self, "wal_delete_retry_script", "pre")
retry_script.env_from_wal_info(wal_info)
retry_script.run()
error = None
try:
os.unlink(wal_info.fullpath(self.server))
try:
os.removedirs(os.path.dirname(wal_info.fullpath(self.server)))
except OSError:
# This is not an error condition
# We always try to remove the the trailing directories,
# this means that hashdir is not empty.
pass
except OSError as e:
error = "Ignoring deletion of WAL file %s for server %s: %s" % (
wal_info.name,
self.config.name,
e,
)
output.warning(error)
# Run the post_wal_delete_retry_script if present.
try:
retry_script = RetryHookScriptRunner(
self, "wal_delete_retry_script", "post"
)
retry_script.env_from_wal_info(wal_info, None, error)
retry_script.run()
except AbortedRetryHookScript as e:
# Ignore the ABORT_STOP as it is a post-hook operation
_logger.warning(
"Ignoring stop request after receiving "
"abort (exit code %d) from post-wal-delete "
"retry hook script: %s",
e.hook.exit_status,
e.hook.script,
)
# Run the post_wal_delete_script if present.
script = HookScriptRunner(self, "wal_delete_script", "post")
script.env_from_wal_info(wal_info, None, error)
script.run()
def check(self, check_strategy):
"""
This function does some checks on the server.
:param CheckStrategy check_strategy: the strategy for the management
of the results of the various checks
"""
check_strategy.init_check("compression settings")
# Check compression_setting parameter
if self.config.compression and not self.compression_manager.check():
check_strategy.result(self.config.name, False)
else:
status = True
try:
self.compression_manager.get_default_compressor()
except CompressionIncompatibility as field:
check_strategy.result(self.config.name, "%s setting" % field, False)
status = False
check_strategy.result(self.config.name, status)
# Failed backups check
check_strategy.init_check("failed backups")
failed_backups = self.get_available_backups((BackupInfo.FAILED,))
status = len(failed_backups) == 0
check_strategy.result(
self.config.name,
status,
hint="there are %s failed backups"
% (
len(
failed_backups,
)
),
)
check_strategy.init_check("minimum redundancy requirements")
# Minimum redundancy checks
no_backups = len(self.get_available_backups(status_filter=(BackupInfo.DONE,)))
# Check minimum_redundancy_requirements parameter
if no_backups < int(self.config.minimum_redundancy):
status = False
else:
status = True
check_strategy.result(
self.config.name,
status,
hint="have %s backups, expected at least %s"
% (no_backups, self.config.minimum_redundancy),
)
# TODO: Add a check for the existence of ssh and of rsync
# Execute additional checks defined by the BackupExecutor
if self.executor:
self.executor.check(check_strategy)
def status(self):
"""
This function show the server status
"""
# get number of backups
no_backups = len(self.get_available_backups(status_filter=(BackupInfo.DONE,)))
output.result(
"status",
self.config.name,
"backups_number",
"No. of available backups",
no_backups,
)
output.result(
"status",
self.config.name,
"first_backup",
"First available backup",
self.get_first_backup_id(),
)
output.result(
"status",
self.config.name,
"last_backup",
"Last available backup",
self.get_last_backup_id(),
)
# Minimum redundancy check. if number of backups minor than minimum
# redundancy, fail.
if no_backups < self.config.minimum_redundancy:
output.result(
"status",
self.config.name,
"minimum_redundancy",
"Minimum redundancy requirements",
"FAILED (%s/%s)" % (no_backups, self.config.minimum_redundancy),
)
else:
output.result(
"status",
self.config.name,
"minimum_redundancy",
"Minimum redundancy requirements",
"satisfied (%s/%s)" % (no_backups, self.config.minimum_redundancy),
)
# Output additional status defined by the BackupExecutor
if self.executor:
self.executor.status()
def fetch_remote_status(self):
"""
Build additional remote status lines defined by the BackupManager.
This method does not raise any exception in case of errors,
but set the missing values to None in the resulting dictionary.
:rtype: dict[str, None|str]
"""
if self.executor:
return self.executor.get_remote_status()
else:
return {}
def rebuild_xlogdb(self):
"""
Rebuild the whole xlog database guessing it from the archive content.
"""
from os.path import isdir, join
output.info("Rebuilding xlogdb for server %s", self.config.name)
root = self.config.wals_directory
comp_manager = self.compression_manager
wal_count = label_count = history_count = 0
# lock the xlogdb as we are about replacing it completely
with self.server.xlogdb("w") as fxlogdb:
xlogdb_dir = os.path.dirname(fxlogdb.name)
with tempfile.TemporaryFile(mode="w+", dir=xlogdb_dir) as fxlogdb_new:
for name in sorted(os.listdir(root)):
# ignore the xlogdb and its lockfile
if name.startswith(self.server.XLOG_DB):
continue
fullname = join(root, name)
if isdir(fullname):
# all relevant files are in subdirectories
hash_dir = fullname
for wal_name in sorted(os.listdir(hash_dir)):
fullname = join(hash_dir, wal_name)
if isdir(fullname):
_logger.warning(
"unexpected directory "
"rebuilding the wal database: %s",
fullname,
)
else:
if xlog.is_wal_file(fullname):
wal_count += 1
elif xlog.is_backup_file(fullname):
label_count += 1
elif fullname.endswith(".tmp"):
_logger.warning(
"temporary file found "
"rebuilding the wal database: %s",
fullname,
)
continue
else:
_logger.warning(
"unexpected file "
"rebuilding the wal database: %s",
fullname,
)
continue
wal_info = comp_manager.get_wal_file_info(fullname)
fxlogdb_new.write(wal_info.to_xlogdb_line())
else:
# only history files are here
if xlog.is_history_file(fullname):
history_count += 1
wal_info = comp_manager.get_wal_file_info(fullname)
fxlogdb_new.write(wal_info.to_xlogdb_line())
else:
_logger.warning(
"unexpected file rebuilding the wal database: %s",
fullname,
)
fxlogdb_new.flush()
fxlogdb_new.seek(0)
fxlogdb.seek(0)
shutil.copyfileobj(fxlogdb_new, fxlogdb)
fxlogdb.truncate()
output.info(
"Done rebuilding xlogdb for server %s "
"(history: %s, backup_labels: %s, wal_file: %s)",
self.config.name,
history_count,
label_count,
wal_count,
)
def get_latest_archived_wals_info(self):
"""
Return a dictionary of timelines associated with the
WalFileInfo of the last WAL file in the archive,
or None if the archive doesn't contain any WAL file.
:rtype: dict[str, WalFileInfo]|None
"""
from os.path import isdir, join
root = self.config.wals_directory
comp_manager = self.compression_manager
# If the WAL archive directory doesn't exists the archive is empty
if not isdir(root):
return dict()
# Traverse all the directory in the archive in reverse order,
# returning the first WAL file found
timelines = {}
for name in sorted(os.listdir(root), reverse=True):
fullname = join(root, name)
# All relevant files are in subdirectories, so
# we skip any non-directory entry
if isdir(fullname):
# Extract the timeline. If it is not valid, skip this directory
try:
timeline = name[0:8]
int(timeline, 16)
except ValueError:
continue
# If this timeline already has a file, skip this directory
if timeline in timelines:
continue
hash_dir = fullname
# Inspect contained files in reverse order
for wal_name in sorted(os.listdir(hash_dir), reverse=True):
fullname = join(hash_dir, wal_name)
# Return the first file that has the correct name
if not isdir(fullname) and xlog.is_wal_file(fullname):
timelines[timeline] = comp_manager.get_wal_file_info(fullname)
break
# Return the timeline map
return timelines
def remove_wal_before_backup(
self, backup_info, timelines_to_protect=None, wal_ranges_to_protect=[]
):
"""
Remove WAL files which have been archived before the start of
the provided backup.
If no backup_info is provided delete all available WAL files
If timelines_to_protect list is passed, never remove a wal in one of
these timelines.
:param BackupInfo|None backup_info: the backup information structure
:param set timelines_to_protect: optional list of timelines
to protect
:param list wal_ranges_to_protect: optional list of `(begin_wal, end_wal)`
tuples which define inclusive ranges of WALs which must not be deleted.
:return list: a list of removed WAL files
"""
removed = []
with self.server.xlogdb("r+") as fxlogdb:
xlogdb_dir = os.path.dirname(fxlogdb.name)
with tempfile.TemporaryFile(mode="w+", dir=xlogdb_dir) as fxlogdb_new:
for line in fxlogdb:
wal_info = WalFileInfo.from_xlogdb_line(line)
if not xlog.is_any_xlog_file(wal_info.name):
output.error(
"invalid WAL segment name %r\n"
'HINT: Please run "barman rebuild-xlogdb %s" '
"to solve this issue",
wal_info.name,
self.config.name,
)
continue
# Keeps the WAL segment if it is a history file
keep = xlog.is_history_file(wal_info.name)
# Keeps the WAL segment if its timeline is in
# `timelines_to_protect`
if timelines_to_protect:
tli, _, _ = xlog.decode_segment_name(wal_info.name)
keep |= tli in timelines_to_protect
# Keeps the WAL segment if it is within a protected range
if xlog.is_backup_file(wal_info.name):
# If we have a .backup file then truncate the name for the
# range check
wal_name = wal_info.name[:24]
else:
wal_name = wal_info.name
for begin_wal, end_wal in wal_ranges_to_protect:
keep |= wal_name >= begin_wal and wal_name <= end_wal
# Keeps the WAL segment if it is a newer
# than the given backup (the first available)
if backup_info and backup_info.begin_wal is not None:
keep |= wal_info.name >= backup_info.begin_wal
# If the file has to be kept write it in the new xlogdb
# otherwise delete it and record it in the removed list
if keep:
fxlogdb_new.write(wal_info.to_xlogdb_line())
else:
self.delete_wal(wal_info)
removed.append(wal_info.name)
fxlogdb_new.flush()
fxlogdb_new.seek(0)
fxlogdb.seek(0)
shutil.copyfileobj(fxlogdb_new, fxlogdb)
fxlogdb.truncate()
return removed
def validate_last_backup_maximum_age(self, last_backup_maximum_age):
"""
Evaluate the age of the last available backup in a catalogue.
If the last backup is older than the specified time interval (age),
the function returns False. If within the requested age interval,
the function returns True.
:param timedate.timedelta last_backup_maximum_age: time interval
representing the maximum allowed age for the last backup
in a server catalogue
:return tuple: a tuple containing the boolean result of the check and
auxiliary information about the last backup current age
"""
# Get the ID of the last available backup
backup_id = self.get_last_backup_id()
if backup_id:
# Get the backup object
backup = LocalBackupInfo(self.server, backup_id=backup_id)
now = datetime.datetime.now(dateutil.tz.tzlocal())
# Evaluate the point of validity
validity_time = now - last_backup_maximum_age
# Pretty print of a time interval (age)
msg = human_readable_timedelta(now - backup.end_time)
# If the backup end time is older than the point of validity,
# return False, otherwise return true
if backup.end_time < validity_time:
return False, msg
else:
return True, msg
else:
# If no backup is available return false
return False, "No available backups"
def validate_last_backup_min_size(self, last_backup_minimum_size):
"""
Evaluate the size of the last available backup in a catalogue.
If the last backup is smaller than the specified size
the function returns False.
Otherwise, the function returns True.
:param last_backup_minimum_size: size in bytes
representing the maximum allowed age for the last backup
in a server catalogue
:return tuple: a tuple containing the boolean result of the check and
auxiliary information about the last backup current age
"""
# Get the ID of the last available backup
backup_id = self.get_last_backup_id()
if backup_id:
# Get the backup object
backup = LocalBackupInfo(self.server, backup_id=backup_id)
if backup.size < last_backup_minimum_size:
return False, backup.size
else:
return True, backup.size
else:
# If no backup is available return false
return False, 0
def backup_fsync_and_set_sizes(self, backup_info):
"""
Fsync all files in a backup and set the actual size on disk
of a backup.
Also evaluate the deduplication ratio and the deduplicated size if
applicable.
:param LocalBackupInfo backup_info: the backup to update
"""
# Calculate the base backup size
self.executor.current_action = "calculating backup size"
_logger.debug(self.executor.current_action)
backup_size = 0
deduplicated_size = 0
backup_dest = backup_info.get_basebackup_directory()
for dir_path, _, file_names in os.walk(backup_dest):
# execute fsync() on the containing directory
fsync_dir(dir_path)
# execute fsync() on all the contained files
for filename in file_names:
file_path = os.path.join(dir_path, filename)
file_stat = fsync_file(file_path)
backup_size += file_stat.st_size
# Excludes hard links from real backup size
if file_stat.st_nlink == 1:
deduplicated_size += file_stat.st_size
# Save size into BackupInfo object
backup_info.set_attribute("size", backup_size)
backup_info.set_attribute("deduplicated_size", deduplicated_size)
if backup_info.size > 0:
deduplication_ratio = 1 - (
float(backup_info.deduplicated_size) / backup_info.size
)
else:
deduplication_ratio = 0
if self.config.reuse_backup == "link":
output.info(
"Backup size: %s. Actual size on disk: %s"
" (-%s deduplication ratio)."
% (
pretty_size(backup_info.size),
pretty_size(backup_info.deduplicated_size),
"{percent:.2%}".format(percent=deduplication_ratio),
)
)
else:
output.info("Backup size: %s" % pretty_size(backup_info.size))
def check_backup(self, backup_info):
"""
Make sure that all the required WAL files to check
the consistency of a physical backup (that is, from the
beginning to the end of the full backup) are correctly
archived. This command is automatically invoked by the
cron command and at the end of every backup operation.
:param backup_info: the target backup
"""
# Gather the list of the latest archived wals
timelines = self.get_latest_archived_wals_info()
# Get the basic info for the backup
begin_wal = backup_info.begin_wal
end_wal = backup_info.end_wal
timeline = begin_wal[:8]
# Case 0: there is nothing to check for this backup, as it is
# currently in progress
if not end_wal:
return
# Case 1: Barman still doesn't know about the timeline the backup
# started with. We still haven't archived any WAL corresponding
# to the backup, so we can't proceed with checking the existence
# of the required WAL files
if not timelines or timeline not in timelines:
backup_info.status = BackupInfo.WAITING_FOR_WALS
backup_info.save()
return
# Find the most recent archived WAL for this server in the timeline
# where the backup was taken
last_archived_wal = timelines[timeline].name
# Case 2: the most recent WAL file archived is older than the
# start of the backup. We must wait for the archiver to receive
# and/or process the WAL files.
if last_archived_wal < begin_wal:
backup_info.status = BackupInfo.WAITING_FOR_WALS
backup_info.save()
return
# Check the intersection between the required WALs and the archived
# ones. They should all exist
segments = backup_info.get_required_wal_segments()
missing_wal = None
for wal in segments:
# Stop checking if we reach the last archived wal
if wal > last_archived_wal:
break
wal_full_path = self.server.get_wal_full_path(wal)
if not os.path.exists(wal_full_path):
missing_wal = wal
break
if missing_wal:
# Case 3: the most recent WAL file archived is more recent than
# the one corresponding to the start of a backup. If WAL
# file is missing, then we can't recover from the backup so we
# must mark the backup as FAILED.
# TODO: Verify if the error field is the right place
# to store the error message
backup_info.error = (
"At least one WAL file is missing. "
"The first missing WAL file is %s" % missing_wal
)
backup_info.status = BackupInfo.FAILED
backup_info.save()
return
if end_wal <= last_archived_wal:
# Case 4: if the most recent WAL file archived is more recent or
# equal than the one corresponding to the end of the backup and
# every WAL that will be required by the recovery is available,
# we can mark the backup as DONE.
backup_info.status = BackupInfo.DONE
else:
# Case 5: if the most recent WAL file archived is older than
# the one corresponding to the end of the backup but
# all the WAL files until that point are present.
backup_info.status = BackupInfo.WAITING_FOR_WALS
backup_info.save()
def verify_backup(self, backup_info):
"""
This function should check if pg_verifybackup is installed and run it against backup path
should test if pg_verifybackup is installed locally
:param backup_info: barman.infofile.LocalBackupInfo instance
"""
output.info("Calling pg_verifybackup")
# Test pg_verifybackup existence
version_info = PgVerifyBackup.get_version_info(self.server.path)
if version_info.get("full_path", None) is None:
output.error("pg_verifybackup not found")
return
pg_verifybackup = PgVerifyBackup(
data_path=backup_info.get_data_directory(),
command=version_info["full_path"],
version=version_info["full_version"],
)
try:
pg_verifybackup()
except CommandFailedException as e:
output.error(
"verify backup failure on directory '%s'"
% backup_info.get_data_directory()
)
output.error(e.args[0]["err"])
return
output.info(pg_verifybackup.get_output()[0].strip())
barman-2.18/barman/postgres_plumbing.py 0000644 0006212 0006212 00000006653 14172556763 016467 0 ustar 0000000 0000000 # -*- coding: utf-8 -*-
# © Copyright EnterpriseDB UK Limited 2011-2022
#
# This file is part of Barman.
#
# Barman is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Barman is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Barman. If not, see .
"""
PostgreSQL Plumbing module
This module contain low-level PostgreSQL related information, such as the
on-disk structure and the name of the core functions in different PostgreSQL
versions.
"""
PGDATA_EXCLUDE_LIST = [
# Exclude log files (pg_log was renamed to log in Postgres v10)
"/pg_log/*",
"/log/*",
# Exclude WAL files (pg_xlog was renamed to pg_wal in Postgres v10)
"/pg_xlog/*",
"/pg_wal/*",
# We handle this on a different step of the copy
"/global/pg_control",
]
EXCLUDE_LIST = [
# Files: see excludeFiles const in PostgreSQL source
"pgsql_tmp*",
"postgresql.auto.conf.tmp",
"current_logfiles.tmp",
"pg_internal.init",
"postmaster.pid",
"postmaster.opts",
"recovery.conf",
"standby.signal",
# Directories: see excludeDirContents const in PostgreSQL source
"pg_dynshmem/*",
"pg_notify/*",
"pg_replslot/*",
"pg_serial/*",
"pg_stat_tmp/*",
"pg_snapshots/*",
"pg_subtrans/*",
]
def function_name_map(server_version):
"""
Return a map with function and directory names according to the current
PostgreSQL version.
Each entry has the `current` name as key and the name for the specific
version as value.
:param number|None server_version: Version of PostgreSQL as returned by
psycopg2 (i.e. 90301 represent PostgreSQL 9.3.1). If the version
is None, default to the latest PostgreSQL version
:rtype: dict[str]
"""
if server_version and server_version < 100000:
return {
"pg_switch_wal": "pg_switch_xlog",
"pg_walfile_name": "pg_xlogfile_name",
"pg_wal": "pg_xlog",
"pg_walfile_name_offset": "pg_xlogfile_name_offset",
"pg_last_wal_replay_lsn": "pg_last_xlog_replay_location",
"pg_current_wal_lsn": "pg_current_xlog_location",
"pg_current_wal_insert_lsn": "pg_current_xlog_insert_location",
"pg_last_wal_receive_lsn": "pg_last_xlog_receive_location",
"sent_lsn": "sent_location",
"write_lsn": "write_location",
"flush_lsn": "flush_location",
"replay_lsn": "replay_location",
}
return {
"pg_switch_wal": "pg_switch_wal",
"pg_walfile_name": "pg_walfile_name",
"pg_wal": "pg_wal",
"pg_walfile_name_offset": "pg_walfile_name_offset",
"pg_last_wal_replay_lsn": "pg_last_wal_replay_lsn",
"pg_current_wal_lsn": "pg_current_wal_lsn",
"pg_current_wal_insert_lsn": "pg_current_wal_insert_lsn",
"pg_last_wal_receive_lsn": "pg_last_wal_receive_lsn",
"sent_lsn": "sent_lsn",
"write_lsn": "write_lsn",
"flush_lsn": "flush_lsn",
"replay_lsn": "replay_lsn",
}
barman-2.18/barman/remote_status.py 0000644 0006212 0006212 00000004413 14172556763 015612 0 ustar 0000000 0000000 # -*- coding: utf-8 -*-
# © Copyright EnterpriseDB UK Limited 2011-2022
#
# This file is part of Barman.
#
# Barman is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Barman is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Barman. If not, see .
"""
Remote Status module
A Remote Status class implements a standard interface for
retrieving and caching the results of a remote component
(such as Postgres server, WAL archiver, etc.). It follows
the Mixin pattern.
"""
from abc import ABCMeta, abstractmethod
from barman.utils import with_metaclass
class RemoteStatusMixin(with_metaclass(ABCMeta, object)):
"""
Abstract base class that implements remote status capabilities
following the Mixin pattern.
"""
def __init__(self, *args, **kwargs):
"""
Base constructor (Mixin pattern)
"""
self._remote_status = None
super(RemoteStatusMixin, self).__init__(*args, **kwargs)
@abstractmethod
def fetch_remote_status(self):
"""
Retrieve status information from the remote component
The implementation of this method must not raise any exception in case
of errors, but should set the missing values to None in the resulting
dictionary.
:rtype: dict[str, None|str]
"""
def get_remote_status(self):
"""
Get the status of the remote component
This method does not raise any exception in case of errors,
but set the missing values to None in the resulting dictionary.
:rtype: dict[str, None|str]
"""
if self._remote_status is None:
self._remote_status = self.fetch_remote_status()
return self._remote_status
def reset_remote_status(self):
"""
Reset the cached result
"""
self._remote_status = None
barman-2.18/barman/exceptions.py 0000644 0006212 0006212 00000021141 14172556763 015072 0 ustar 0000000 0000000 # -*- coding: utf-8 -*-
# © Copyright EnterpriseDB UK Limited 2011-2022
#
# This file is part of Barman.
#
# Barman is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Barman is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Barman. If not, see .
class BarmanException(Exception):
"""
The base class of all other barman exceptions
"""
class ConfigurationException(BarmanException):
"""
Base exception for all the Configuration errors
"""
class CommandException(BarmanException):
"""
Base exception for all the errors related to
the execution of a Command.
"""
class CompressionException(BarmanException):
"""
Base exception for all the errors related to
the execution of a compression action.
"""
class PostgresException(BarmanException):
"""
Base exception for all the errors related to PostgreSQL.
"""
class BackupException(BarmanException):
"""
Base exception for all the errors related to the execution of a backup.
"""
class WALFileException(BarmanException):
"""
Base exception for all the errors related to WAL files.
"""
def __str__(self):
"""
Human readable string representation
"""
return "%s:%s" % (self.__class__.__name__, self.args[0] if self.args else None)
class HookScriptException(BarmanException):
"""
Base exception for all the errors related to Hook Script execution.
"""
class LockFileException(BarmanException):
"""
Base exception for lock related errors
"""
class SyncException(BarmanException):
"""
Base Exception for synchronisation functions
"""
class DuplicateWalFile(WALFileException):
"""
A duplicate WAL file has been found
"""
class MatchingDuplicateWalFile(DuplicateWalFile):
"""
A duplicate WAL file has been found, but it's identical to the one we
already have.
"""
class SshCommandException(CommandException):
"""
Error parsing ssh_command parameter
"""
class UnknownBackupIdException(BackupException):
"""
The searched backup_id doesn't exists
"""
class BackupInfoBadInitialisation(BackupException):
"""
Exception for a bad initialization error
"""
class SyncError(SyncException):
"""
Synchronisation error
"""
class SyncNothingToDo(SyncException):
"""
Nothing to do during sync operations
"""
class SyncToBeDeleted(SyncException):
"""
An incomplete backup is to be deleted
"""
class CommandFailedException(CommandException):
"""
Exception representing a failed command
"""
class CommandMaxRetryExceeded(CommandFailedException):
"""
A command with retry_times > 0 has exceeded the number of available retry
"""
class RsyncListFilesFailure(CommandException):
"""
Failure parsing the output of a "rsync --list-only" command
"""
class DataTransferFailure(CommandException):
"""
Used to pass failure details from a data transfer Command
"""
@classmethod
def from_command_error(cls, cmd, e, msg):
"""
This method build a DataTransferFailure exception and report the
provided message to the user (both console and log file) along with
the output of the failed command.
:param str cmd: The command that failed the transfer
:param CommandFailedException e: The exception we are handling
:param str msg: a descriptive message on what we are trying to do
:return DataTransferFailure: will contain the message provided in msg
"""
try:
details = msg
details += "\n%s error:\n" % cmd
details += e.args[0]["out"]
details += e.args[0]["err"]
return cls(details)
except (TypeError, NameError):
# If it is not a dictionary just convert it to a string
from barman.utils import force_str
return cls(force_str(e.args))
class CompressionIncompatibility(CompressionException):
"""
Exception for compression incompatibility
"""
class FsOperationFailed(CommandException):
"""
Exception which represents a failed execution of a command on FS
"""
class LockFileBusy(LockFileException):
"""
Raised when a lock file is not free
"""
class LockFilePermissionDenied(LockFileException):
"""
Raised when a lock file is not accessible
"""
class LockFileParsingError(LockFileException):
"""
Raised when the content of the lockfile is unexpected
"""
class ConninfoException(ConfigurationException):
"""
Error for missing or failed parsing of the conninfo parameter (DSN)
"""
class PostgresConnectionError(PostgresException):
"""
Error connecting to the PostgreSQL server
"""
def __str__(self):
# Returns the first line
if self.args and self.args[0]:
from barman.utils import force_str
return force_str(self.args[0]).splitlines()[0].strip()
else:
return ""
class PostgresAppNameError(PostgresConnectionError):
"""
Error setting application name with PostgreSQL server
"""
class PostgresSuperuserRequired(PostgresException):
"""
Superuser access is required
"""
class BackupFunctionsAccessRequired(PostgresException):
"""
Superuser or access to backup functions is required
"""
class PostgresIsInRecovery(PostgresException):
"""
PostgreSQL is in recovery, so no write operations are allowed
"""
class PostgresUnsupportedFeature(PostgresException):
"""
Unsupported feature
"""
class PostgresDuplicateReplicationSlot(PostgresException):
"""
The creation of a physical replication slot failed because
the slot already exists
"""
class PostgresReplicationSlotsFull(PostgresException):
"""
The creation of a physical replication slot failed because
the all the replication slots have been taken
"""
class PostgresReplicationSlotInUse(PostgresException):
"""
The drop of a physical replication slot failed because
the replication slots is in use
"""
class PostgresInvalidReplicationSlot(PostgresException):
"""
Exception representing a failure during the deletion of a non
existent replication slot
"""
class TimeoutError(CommandException):
"""
A timeout occurred.
"""
class ArchiverFailure(WALFileException):
"""
Exception representing a failure during the execution
of the archive process
"""
class BadXlogSegmentName(WALFileException):
"""
Exception for a bad xlog name
"""
class BadHistoryFileContents(WALFileException):
"""
Exception for a corrupted history file
"""
class AbortedRetryHookScript(HookScriptException):
"""
Exception for handling abort of retry hook scripts
"""
def __init__(self, hook):
"""
Initialise the exception with hook script info
"""
self.hook = hook
def __str__(self):
"""
String representation
"""
return "Abort '%s_%s' retry hook script (%s, exit code: %d)" % (
self.hook.phase,
self.hook.name,
self.hook.script,
self.hook.exit_status,
)
class RecoveryException(BarmanException):
"""
Exception for a recovery error
"""
class RecoveryTargetActionException(RecoveryException):
"""
Exception for a wrong recovery target action
"""
class RecoveryStandbyModeException(RecoveryException):
"""
Exception for a wrong recovery standby mode
"""
class RecoveryInvalidTargetException(RecoveryException):
"""
Exception for a wrong recovery target
"""
class UnrecoverableHookScriptError(BarmanException):
"""
Exception for hook script errors which mean the script should not be retried.
"""
class ArchivalBackupException(BarmanException):
"""
Exception for errors concerning archival backups.
"""
class WalArchiveContentError(BarmanException):
"""
Exception raised when unexpected content is detected in the WAL archive.
"""
class InvalidRetentionPolicy(BarmanException):
"""
Exception raised when a retention policy cannot be parsed.
"""
barman-2.18/barman/wal_archiver.py 0000644 0006212 0006212 00000122763 14172556763 015373 0 ustar 0000000 0000000 # -*- coding: utf-8 -*-
# © Copyright EnterpriseDB UK Limited 2011-2022
#
# This file is part of Barman.
#
# Barman is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Barman is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Barman. If not, see
import collections
import datetime
import errno
import filecmp
import logging
import os
import shutil
from abc import ABCMeta, abstractmethod
from glob import glob
from distutils.version import LooseVersion as Version
from barman import output, xlog
from barman.command_wrappers import CommandFailedException, PgReceiveXlog
from barman.exceptions import (
AbortedRetryHookScript,
ArchiverFailure,
DuplicateWalFile,
MatchingDuplicateWalFile,
)
from barman.hooks import HookScriptRunner, RetryHookScriptRunner
from barman.infofile import WalFileInfo
from barman.remote_status import RemoteStatusMixin
from barman.utils import fsync_dir, fsync_file, mkpath, with_metaclass
from barman.xlog import is_partial_file
_logger = logging.getLogger(__name__)
class WalArchiverQueue(list):
def __init__(self, items, errors=None, skip=None, batch_size=0):
"""
A WalArchiverQueue is a list of WalFileInfo which has two extra
attribute list:
* errors: containing a list of unrecognized files
* skip: containing a list of skipped files.
It also stores batch run size information in case
it is requested by configuration, in order to limit the
number of WAL files that are processed in a single
run of the archive-wal command.
:param items: iterable from which initialize the list
:param batch_size: size of the current batch run (0=unlimited)
:param errors: an optional list of unrecognized files
:param skip: an optional list of skipped files
"""
super(WalArchiverQueue, self).__init__(items)
self.skip = []
self.errors = []
if skip is not None:
self.skip = skip
if errors is not None:
self.errors = errors
# Normalises batch run size
if batch_size > 0:
self.batch_size = batch_size
else:
self.batch_size = 0
@property
def size(self):
"""
Number of valid WAL segments waiting to be processed (in total)
:return int: total number of valid WAL files
"""
return len(self)
@property
def run_size(self):
"""
Number of valid WAL files to be processed in this run - takes
in consideration the batch size
:return int: number of valid WAL files for this batch run
"""
# In case a batch size has been explicitly specified
# (i.e. batch_size > 0), returns the minimum number between
# batch size and the queue size. Otherwise, simply
# returns the total queue size (unlimited batch size).
if self.batch_size > 0:
return min(self.size, self.batch_size)
return self.size
class WalArchiver(with_metaclass(ABCMeta, RemoteStatusMixin)):
"""
Base class for WAL archiver objects
"""
def __init__(self, backup_manager, name):
"""
Base class init method.
:param backup_manager: The backup manager
:param name: The name of this archiver
:return:
"""
self.backup_manager = backup_manager
self.server = backup_manager.server
self.config = backup_manager.config
self.name = name
super(WalArchiver, self).__init__()
def receive_wal(self, reset=False):
"""
Manage reception of WAL files. Does nothing by default.
Some archiver classes, like the StreamingWalArchiver, have a full
implementation.
:param bool reset: When set, resets the status of receive-wal
:raise ArchiverFailure: when something goes wrong
"""
def archive(self, verbose=True):
"""
Archive WAL files, discarding duplicates or those that are not valid.
:param boolean verbose: Flag for verbose output
"""
compressor = self.backup_manager.compression_manager.get_default_compressor()
stamp = datetime.datetime.utcnow().strftime("%Y%m%dT%H%M%SZ")
processed = 0
header = "Processing xlog segments from %s for %s" % (
self.name,
self.config.name,
)
# Get the next batch of WAL files to be processed
batch = self.get_next_batch()
# Analyse the batch and properly log the information
if batch.size:
if batch.size > batch.run_size:
# Batch mode enabled
_logger.info(
"Found %s xlog segments from %s for %s."
" Archive a batch of %s segments in this run.",
batch.size,
self.name,
self.config.name,
batch.run_size,
)
header += " (batch size: %s)" % batch.run_size
else:
# Single run mode (traditional)
_logger.info(
"Found %s xlog segments from %s for %s."
" Archive all segments in one run.",
batch.size,
self.name,
self.config.name,
)
else:
_logger.info(
"No xlog segments found from %s for %s.", self.name, self.config.name
)
# Print the header (verbose mode)
if verbose:
output.info(header, log=False)
# Loop through all available WAL files
for wal_info in batch:
# Print the header (non verbose mode)
if not processed and not verbose:
output.info(header, log=False)
# Exit when archive batch size is reached
if processed >= batch.run_size:
_logger.debug(
"Batch size reached (%s) - Exit %s process for %s",
batch.batch_size,
self.name,
self.config.name,
)
break
processed += 1
# Report to the user the WAL file we are archiving
output.info("\t%s", wal_info.name, log=False)
_logger.info(
"Archiving segment %s of %s from %s: %s/%s",
processed,
batch.run_size,
self.name,
self.config.name,
wal_info.name,
)
# Archive the WAL file
try:
self.archive_wal(compressor, wal_info)
except MatchingDuplicateWalFile:
# We already have this file. Simply unlink the file.
os.unlink(wal_info.orig_filename)
continue
except DuplicateWalFile:
output.info(
"\tError: %s is already present in server %s. "
"File moved to errors directory.",
wal_info.name,
self.config.name,
)
error_dst = os.path.join(
self.config.errors_directory,
"%s.%s.duplicate" % (wal_info.name, stamp),
)
# TODO: cover corner case of duplication (unlikely,
# but theoretically possible)
shutil.move(wal_info.orig_filename, error_dst)
continue
except AbortedRetryHookScript as e:
_logger.warning(
"Archiving of %s/%s aborted by "
"pre_archive_retry_script."
"Reason: %s" % (self.config.name, wal_info.name, e)
)
return
if processed:
_logger.debug(
"Archived %s out of %s xlog segments from %s for %s",
processed,
batch.size,
self.name,
self.config.name,
)
elif verbose:
output.info("\tno file found", log=False)
if batch.errors:
output.info(
"Some unknown objects have been found while "
"processing xlog segments for %s. "
"Objects moved to errors directory:",
self.config.name,
log=False,
)
# Log unexpected files
_logger.warning(
"Archiver is about to move %s unexpected file(s) "
"to errors directory for %s from %s",
len(batch.errors),
self.config.name,
self.name,
)
for error in batch.errors:
basename = os.path.basename(error)
output.info("\t%s", basename, log=False)
# Print informative log line.
_logger.warning(
"Moving unexpected file for %s from %s: %s",
self.config.name,
self.name,
basename,
)
error_dst = os.path.join(
self.config.errors_directory, "%s.%s.unknown" % (basename, stamp)
)
try:
shutil.move(error, error_dst)
except IOError as e:
if e.errno == errno.ENOENT:
_logger.warning("%s not found" % error)
def archive_wal(self, compressor, wal_info):
"""
Archive a WAL segment and update the wal_info object
:param compressor: the compressor for the file (if any)
:param WalFileInfo wal_info: the WAL file is being processed
"""
src_file = wal_info.orig_filename
src_dir = os.path.dirname(src_file)
dst_file = wal_info.fullpath(self.server)
tmp_file = dst_file + ".tmp"
dst_dir = os.path.dirname(dst_file)
comp_manager = self.backup_manager.compression_manager
error = None
try:
# Run the pre_archive_script if present.
script = HookScriptRunner(self.backup_manager, "archive_script", "pre")
script.env_from_wal_info(wal_info, src_file)
script.run()
# Run the pre_archive_retry_script if present.
retry_script = RetryHookScriptRunner(
self.backup_manager, "archive_retry_script", "pre"
)
retry_script.env_from_wal_info(wal_info, src_file)
retry_script.run()
# Check if destination already exists
if os.path.exists(dst_file):
src_uncompressed = src_file
dst_uncompressed = dst_file
dst_info = comp_manager.get_wal_file_info(dst_file)
try:
if dst_info.compression is not None:
dst_uncompressed = dst_file + ".uncompressed"
comp_manager.get_compressor(dst_info.compression).decompress(
dst_file, dst_uncompressed
)
if wal_info.compression:
src_uncompressed = src_file + ".uncompressed"
comp_manager.get_compressor(wal_info.compression).decompress(
src_file, src_uncompressed
)
# Directly compare files.
# When the files are identical
# raise a MatchingDuplicateWalFile exception,
# otherwise raise a DuplicateWalFile exception.
if filecmp.cmp(dst_uncompressed, src_uncompressed):
raise MatchingDuplicateWalFile(wal_info)
else:
raise DuplicateWalFile(wal_info)
finally:
if src_uncompressed != src_file:
os.unlink(src_uncompressed)
if dst_uncompressed != dst_file:
os.unlink(dst_uncompressed)
mkpath(dst_dir)
# Compress the file only if not already compressed
if compressor and not wal_info.compression:
compressor.compress(src_file, tmp_file)
# Perform the real filesystem operation with the xlogdb lock taken.
# This makes the operation atomic from the xlogdb file POV
with self.server.xlogdb("a") as fxlogdb:
if compressor and not wal_info.compression:
shutil.copystat(src_file, tmp_file)
os.rename(tmp_file, dst_file)
os.unlink(src_file)
# Update wal_info
stat = os.stat(dst_file)
wal_info.size = stat.st_size
wal_info.compression = compressor.compression
else:
# Try to atomically rename the file. If successful,
# the renaming will be an atomic operation
# (this is a POSIX requirement).
try:
os.rename(src_file, dst_file)
except OSError:
# Source and destination are probably on different
# filesystems
shutil.copy2(src_file, tmp_file)
os.rename(tmp_file, dst_file)
os.unlink(src_file)
# At this point the original file has been removed
wal_info.orig_filename = None
# Execute fsync() on the archived WAL file
fsync_file(dst_file)
# Execute fsync() on the archived WAL containing directory
fsync_dir(dst_dir)
# Execute fsync() also on the incoming directory
fsync_dir(src_dir)
# Updates the information of the WAL archive with
# the latest segments
fxlogdb.write(wal_info.to_xlogdb_line())
# flush and fsync for every line
fxlogdb.flush()
os.fsync(fxlogdb.fileno())
except Exception as e:
# In case of failure save the exception for the post scripts
error = e
raise
# Ensure the execution of the post_archive_retry_script and
# the post_archive_script
finally:
# Run the post_archive_retry_script if present.
try:
retry_script = RetryHookScriptRunner(
self, "archive_retry_script", "post"
)
retry_script.env_from_wal_info(wal_info, dst_file, error)
retry_script.run()
except AbortedRetryHookScript as e:
# Ignore the ABORT_STOP as it is a post-hook operation
_logger.warning(
"Ignoring stop request after receiving "
"abort (exit code %d) from post-archive "
"retry hook script: %s",
e.hook.exit_status,
e.hook.script,
)
# Run the post_archive_script if present.
script = HookScriptRunner(self, "archive_script", "post", error)
script.env_from_wal_info(wal_info, dst_file)
script.run()
@abstractmethod
def get_next_batch(self):
"""
Return a WalArchiverQueue containing the WAL files to be archived.
:rtype: WalArchiverQueue
"""
@abstractmethod
def check(self, check_strategy):
"""
Perform specific checks for the archiver - invoked
by server.check_postgres
:param CheckStrategy check_strategy: the strategy for the management
of the results of the various checks
"""
@abstractmethod
def status(self):
"""
Set additional status info - invoked by Server.status()
"""
@staticmethod
def summarise_error_files(error_files):
"""
Summarise a error files list
:param list[str] error_files: Error files list to summarise
:return str: A summary, None if there are no error files
"""
if not error_files:
return None
# The default value for this dictionary will be 0
counters = collections.defaultdict(int)
# Count the file types
for name in error_files:
if name.endswith(".error"):
counters["not relevant"] += 1
elif name.endswith(".duplicate"):
counters["duplicates"] += 1
elif name.endswith(".unknown"):
counters["unknown"] += 1
else:
counters["unknown failure"] += 1
# Return a summary list of the form: "item a: 2, item b: 5"
return ", ".join("%s: %s" % entry for entry in counters.items())
class FileWalArchiver(WalArchiver):
"""
Manager of file-based WAL archiving operations (aka 'log shipping').
"""
def __init__(self, backup_manager):
super(FileWalArchiver, self).__init__(backup_manager, "file archival")
def fetch_remote_status(self):
"""
Returns the status of the FileWalArchiver.
This method does not raise any exception in case of errors,
but set the missing values to None in the resulting dictionary.
:rtype: dict[str, None|str]
"""
result = dict.fromkeys(["archive_mode", "archive_command"], None)
postgres = self.server.postgres
# If Postgres is not available we cannot detect anything
if not postgres:
return result
# Query the database for 'archive_mode' and 'archive_command'
result["archive_mode"] = postgres.get_setting("archive_mode")
result["archive_command"] = postgres.get_setting("archive_command")
# Add pg_stat_archiver statistics if the view is supported
pg_stat_archiver = postgres.get_archiver_stats()
if pg_stat_archiver is not None:
result.update(pg_stat_archiver)
return result
def get_next_batch(self):
"""
Returns the next batch of WAL files that have been archived through
a PostgreSQL's 'archive_command' (in the 'incoming' directory)
:return: WalArchiverQueue: list of WAL files
"""
# Get the batch size from configuration (0 = unlimited)
batch_size = self.config.archiver_batch_size
# List and sort all files in the incoming directory
# IMPORTANT: the list is sorted, and this allows us to know that the
# WAL stream we have is monotonically increasing. That allows us to
# verify that a backup has all the WALs required for the restore.
file_names = glob(os.path.join(self.config.incoming_wals_directory, "*"))
file_names.sort()
# Process anything that looks like a valid WAL file. Anything
# else is treated like an error/anomaly
files = []
errors = []
for file_name in file_names:
# Ignore temporary files
if file_name.endswith(".tmp"):
continue
if xlog.is_any_xlog_file(file_name) and os.path.isfile(file_name):
files.append(file_name)
else:
errors.append(file_name)
# Build the list of WalFileInfo
wal_files = [
WalFileInfo.from_file(f, self.backup_manager.compression_manager)
for f in files
]
return WalArchiverQueue(wal_files, batch_size=batch_size, errors=errors)
def check(self, check_strategy):
"""
Perform additional checks for FileWalArchiver - invoked
by server.check_postgres
:param CheckStrategy check_strategy: the strategy for the management
of the results of the various checks
"""
check_strategy.init_check("archive_mode")
remote_status = self.get_remote_status()
# If archive_mode is None, there are issues connecting to PostgreSQL
if remote_status["archive_mode"] is None:
return
# Check archive_mode parameter: must be on
if remote_status["archive_mode"] in ("on", "always"):
check_strategy.result(self.config.name, True)
else:
msg = "please set it to 'on'"
if self.server.postgres.server_version >= 90500:
msg += " or 'always'"
check_strategy.result(self.config.name, False, hint=msg)
check_strategy.init_check("archive_command")
if (
remote_status["archive_command"]
and remote_status["archive_command"] != "(disabled)"
):
check_strategy.result(self.config.name, True, check="archive_command")
# Report if the archiving process works without issues.
# Skip if the archive_command check fails
# It can be None if PostgreSQL is older than 9.4
if remote_status.get("is_archiving") is not None:
check_strategy.result(
self.config.name,
remote_status["is_archiving"],
check="continuous archiving",
)
else:
check_strategy.result(
self.config.name,
False,
hint="please set it accordingly to documentation",
)
def status(self):
"""
Set additional status info - invoked by Server.status()
"""
# We need to get full info here from the server
remote_status = self.server.get_remote_status()
# If archive_mode is None, there are issues connecting to PostgreSQL
if remote_status["archive_mode"] is None:
return
output.result(
"status",
self.config.name,
"archive_command",
"PostgreSQL 'archive_command' setting",
remote_status["archive_command"]
or "FAILED (please set it accordingly to documentation)",
)
last_wal = remote_status.get("last_archived_wal")
# If PostgreSQL is >= 9.4 we have the last_archived_time
if last_wal and remote_status.get("last_archived_time"):
last_wal += ", at %s" % (remote_status["last_archived_time"].ctime())
output.result(
"status",
self.config.name,
"last_archived_wal",
"Last archived WAL",
last_wal or "No WAL segment shipped yet",
)
# Set output for WAL archive failures (PostgreSQL >= 9.4)
if remote_status.get("failed_count") is not None:
remote_fail = str(remote_status["failed_count"])
if int(remote_status["failed_count"]) > 0:
remote_fail += " (%s at %s)" % (
remote_status["last_failed_wal"],
remote_status["last_failed_time"].ctime(),
)
output.result(
"status",
self.config.name,
"failed_count",
"Failures of WAL archiver",
remote_fail,
)
# Add hourly archive rate if available (PostgreSQL >= 9.4) and > 0
if remote_status.get("current_archived_wals_per_second"):
output.result(
"status",
self.config.name,
"server_archived_wals_per_hour",
"Server WAL archiving rate",
"%0.2f/hour"
% (3600 * remote_status["current_archived_wals_per_second"]),
)
class StreamingWalArchiver(WalArchiver):
"""
Object used for the management of streaming WAL archive operation.
"""
def __init__(self, backup_manager):
super(StreamingWalArchiver, self).__init__(backup_manager, "streaming")
def fetch_remote_status(self):
"""
Execute checks for replication-based wal archiving
This method does not raise any exception in case of errors,
but set the missing values to None in the resulting dictionary.
:rtype: dict[str, None|str]
"""
remote_status = dict.fromkeys(
(
"pg_receivexlog_compatible",
"pg_receivexlog_installed",
"pg_receivexlog_path",
"pg_receivexlog_supports_slots",
"pg_receivexlog_synchronous",
"pg_receivexlog_version",
),
None,
)
# Test pg_receivexlog existence
version_info = PgReceiveXlog.get_version_info(self.server.path)
if version_info["full_path"]:
remote_status["pg_receivexlog_installed"] = True
remote_status["pg_receivexlog_path"] = version_info["full_path"]
remote_status["pg_receivexlog_version"] = version_info["full_version"]
pgreceivexlog_version = version_info["major_version"]
else:
remote_status["pg_receivexlog_installed"] = False
return remote_status
# Retrieve the PostgreSQL version
pg_version = None
if self.server.streaming is not None:
pg_version = self.server.streaming.server_major_version
# If one of the version is unknown we cannot compare them
if pgreceivexlog_version is None or pg_version is None:
return remote_status
# pg_version is not None so transform into a Version object
# for easier comparison between versions
pg_version = Version(pg_version)
# Set conservative default values (False) for modern features
remote_status["pg_receivexlog_compatible"] = False
remote_status["pg_receivexlog_supports_slots"] = False
remote_status["pg_receivexlog_synchronous"] = False
# pg_receivexlog 9.2 is compatible only with PostgreSQL 9.2.
if "9.2" == pg_version == pgreceivexlog_version:
remote_status["pg_receivexlog_compatible"] = True
# other versions are compatible with lesser versions of PostgreSQL
# WARNING: The development versions of `pg_receivexlog` are considered
# higher than the stable versions here, but this is not an issue
# because it accepts everything that is less than
# the `pg_receivexlog` version(e.g. '9.6' is less than '9.6devel')
elif "9.2" < pg_version <= pgreceivexlog_version:
# At least PostgreSQL 9.3 is required here
remote_status["pg_receivexlog_compatible"] = True
# replication slots are supported starting from version 9.4
if "9.4" <= pg_version <= pgreceivexlog_version:
remote_status["pg_receivexlog_supports_slots"] = True
# Synchronous WAL streaming requires replication slots
# and pg_receivexlog >= 9.5
if "9.4" <= pg_version and "9.5" <= pgreceivexlog_version:
remote_status["pg_receivexlog_synchronous"] = self._is_synchronous()
return remote_status
def receive_wal(self, reset=False):
"""
Creates a PgReceiveXlog object and issues the pg_receivexlog command
for a specific server
:param bool reset: When set reset the status of receive-wal
:raise ArchiverFailure: when something goes wrong
"""
# Ensure the presence of the destination directory
mkpath(self.config.streaming_wals_directory)
# Execute basic sanity checks on PostgreSQL connection
streaming_status = self.server.streaming.get_remote_status()
if streaming_status["streaming_supported"] is None:
raise ArchiverFailure(
"failed opening the PostgreSQL streaming connection "
"for server %s" % (self.config.name)
)
elif not streaming_status["streaming_supported"]:
raise ArchiverFailure(
"PostgreSQL version too old (%s < 9.2)"
% self.server.streaming.server_txt_version
)
# Execute basic sanity checks on pg_receivexlog
command = "pg_receivewal"
if self.server.streaming.server_version < 100000:
command = "pg_receivexlog"
remote_status = self.get_remote_status()
if not remote_status["pg_receivexlog_installed"]:
raise ArchiverFailure("%s not present in $PATH" % command)
if not remote_status["pg_receivexlog_compatible"]:
raise ArchiverFailure(
"%s version not compatible with PostgreSQL server version" % command
)
# Execute sanity check on replication slot usage
postgres_status = self.server.postgres.get_remote_status()
if self.config.slot_name:
# Check if slots are supported
if not remote_status["pg_receivexlog_supports_slots"]:
raise ArchiverFailure(
"Physical replication slot not supported by %s "
"(9.4 or higher is required)"
% self.server.streaming.server_txt_version
)
# Check if the required slot exists
if postgres_status["replication_slot"] is None:
if self.config.create_slot == "auto":
if not reset:
output.info(
"Creating replication slot '%s'", self.config.slot_name
)
self.server.create_physical_repslot()
else:
raise ArchiverFailure(
"replication slot '%s' doesn't exist. "
"Please execute "
"'barman receive-wal --create-slot %s'"
% (self.config.slot_name, self.config.name)
)
# Check if the required slot is available
elif postgres_status["replication_slot"].active:
raise ArchiverFailure(
"replication slot '%s' is already in use" % (self.config.slot_name,)
)
# Check if is a reset request
if reset:
self._reset_streaming_status(postgres_status, streaming_status)
return
# Check the size of the .partial WAL file and truncate it if needed
self._truncate_partial_file_if_needed(postgres_status["xlog_segment_size"])
# Make sure we are not wasting precious PostgreSQL resources
self.server.close()
_logger.info("Activating WAL archiving through streaming protocol")
try:
output_handler = PgReceiveXlog.make_output_handler(self.config.name + ": ")
receive = PgReceiveXlog(
connection=self.server.streaming,
destination=self.config.streaming_wals_directory,
command=remote_status["pg_receivexlog_path"],
version=remote_status["pg_receivexlog_version"],
app_name=self.config.streaming_archiver_name,
path=self.server.path,
slot_name=self.config.slot_name,
synchronous=remote_status["pg_receivexlog_synchronous"],
out_handler=output_handler,
err_handler=output_handler,
)
# Finally execute the pg_receivexlog process
receive.execute()
except CommandFailedException as e:
# Retrieve the return code from the exception
ret_code = e.args[0]["ret"]
if ret_code < 0:
# If the return code is negative, then pg_receivexlog
# was terminated by a signal
msg = "%s terminated by signal: %s" % (command, abs(ret_code))
else:
# Otherwise terminated with an error
msg = "%s terminated with error code: %s" % (command, ret_code)
raise ArchiverFailure(msg)
except KeyboardInterrupt:
# This is a normal termination, so there is nothing to do beside
# informing the user.
output.info("SIGINT received. Terminate gracefully.")
def _reset_streaming_status(self, postgres_status, streaming_status):
"""
Reset the status of receive-wal by removing the .partial file that
is marking the current position and creating one that is current with
the PostgreSQL insert location
"""
current_wal = xlog.location_to_xlogfile_name_offset(
postgres_status["current_lsn"],
streaming_status["timeline"],
postgres_status["xlog_segment_size"],
)["file_name"]
restart_wal = current_wal
if (
postgres_status["replication_slot"]
and postgres_status["replication_slot"].restart_lsn
):
restart_wal = xlog.location_to_xlogfile_name_offset(
postgres_status["replication_slot"].restart_lsn,
streaming_status["timeline"],
postgres_status["xlog_segment_size"],
)["file_name"]
restart_path = os.path.join(self.config.streaming_wals_directory, restart_wal)
restart_partial_path = restart_path + ".partial"
wal_files = sorted(
glob(os.path.join(self.config.streaming_wals_directory, "*")), reverse=True
)
# Pick the newer file
last = None
for last in wal_files:
if xlog.is_wal_file(last) or xlog.is_partial_file(last):
break
# Check if the status is already up-to-date
if not last or last == restart_partial_path or last == restart_path:
output.info("Nothing to do. Position of receive-wal is aligned.")
return
if os.path.basename(last) > current_wal:
output.error(
"The receive-wal position is ahead of PostgreSQL "
"current WAL lsn (%s > %s)",
os.path.basename(last),
postgres_status["current_xlog"],
)
return
output.info("Resetting receive-wal directory status")
if xlog.is_partial_file(last):
output.info("Removing status file %s" % last)
os.unlink(last)
output.info("Creating status file %s" % restart_partial_path)
open(restart_partial_path, "w").close()
def _truncate_partial_file_if_needed(self, xlog_segment_size):
"""
Truncate .partial WAL file if size is not 0 or xlog_segment_size
:param int xlog_segment_size:
"""
# Retrieve the partial list (only one is expected)
partial_files = glob(
os.path.join(self.config.streaming_wals_directory, "*.partial")
)
# Take the last partial file, ignoring wrongly formatted file names
last_partial = None
for partial in partial_files:
if not is_partial_file(partial):
continue
if not last_partial or partial > last_partial:
last_partial = partial
# Skip further work if there is no good partial file
if not last_partial:
return
# If size is either 0 or wal_segment_size everything is fine...
partial_size = os.path.getsize(last_partial)
if partial_size == 0 or partial_size == xlog_segment_size:
return
# otherwise truncate the file to be empty. This is safe because
# pg_receivewal pads the file to the full size before start writing.
output.info(
"Truncating partial file %s that has wrong size %s "
"while %s was expected." % (last_partial, partial_size, xlog_segment_size)
)
open(last_partial, "wb").close()
def get_next_batch(self):
"""
Returns the next batch of WAL files that have been archived via
streaming replication (in the 'streaming' directory)
This method always leaves one file in the "streaming" directory,
because the 'pg_receivexlog' process needs at least one file to
detect the current streaming position after a restart.
:return: WalArchiverQueue: list of WAL files
"""
# Get the batch size from configuration (0 = unlimited)
batch_size = self.config.streaming_archiver_batch_size
# List and sort all files in the incoming directory.
# IMPORTANT: the list is sorted, and this allows us to know that the
# WAL stream we have is monotonically increasing. That allows us to
# verify that a backup has all the WALs required for the restore.
file_names = glob(os.path.join(self.config.streaming_wals_directory, "*"))
file_names.sort()
# Process anything that looks like a valid WAL file,
# including partial ones and history files.
# Anything else is treated like an error/anomaly
files = []
skip = []
errors = []
for file_name in file_names:
# Ignore temporary files
if file_name.endswith(".tmp"):
continue
# If the file doesn't exist, it has been renamed/removed while
# we were reading the directory. Ignore it.
if not os.path.exists(file_name):
continue
if not os.path.isfile(file_name):
errors.append(file_name)
elif xlog.is_partial_file(file_name):
skip.append(file_name)
elif xlog.is_any_xlog_file(file_name):
files.append(file_name)
else:
errors.append(file_name)
# In case of more than a partial file, keep the last
# and treat the rest as normal files
if len(skip) > 1:
partials = skip[:-1]
_logger.info(
"Archiving partial files for server %s: %s"
% (self.config.name, ", ".join([os.path.basename(f) for f in partials]))
)
files.extend(partials)
skip = skip[-1:]
# Keep the last full WAL file in case no partial file is present
elif len(skip) == 0 and files:
skip.append(files.pop())
# Build the list of WalFileInfo
wal_files = [WalFileInfo.from_file(f, compression=None) for f in files]
return WalArchiverQueue(
wal_files, batch_size=batch_size, errors=errors, skip=skip
)
def check(self, check_strategy):
"""
Perform additional checks for StreamingWalArchiver - invoked
by server.check_postgres
:param CheckStrategy check_strategy: the strategy for the management
of the results of the various checks
"""
check_strategy.init_check("pg_receivexlog")
# Check the version of pg_receivexlog
remote_status = self.get_remote_status()
check_strategy.result(
self.config.name, remote_status["pg_receivexlog_installed"]
)
hint = None
check_strategy.init_check("pg_receivexlog compatible")
if not remote_status["pg_receivexlog_compatible"]:
pg_version = "Unknown"
if self.server.streaming is not None:
pg_version = self.server.streaming.server_txt_version
hint = "PostgreSQL version: %s, pg_receivexlog version: %s" % (
pg_version,
remote_status["pg_receivexlog_version"],
)
check_strategy.result(
self.config.name, remote_status["pg_receivexlog_compatible"], hint=hint
)
# Check if pg_receivexlog is running, by retrieving a list
# of running 'receive-wal' processes from the process manager.
receiver_list = self.server.process_manager.list("receive-wal")
# If there's at least one 'receive-wal' process running for this
# server, the test is passed
check_strategy.init_check("receive-wal running")
if receiver_list:
check_strategy.result(self.config.name, True)
else:
check_strategy.result(
self.config.name, False, hint="See the Barman log file for more details"
)
def _is_synchronous(self):
"""
Check if receive-wal process is eligible for synchronous replication
The receive-wal process is eligible for synchronous replication
if `synchronous_standby_names` is configured and contains
the value of `streaming_archiver_name`
:rtype: bool
"""
# Nothing to do if postgres connection is not working
postgres = self.server.postgres
if postgres is None or postgres.server_txt_version is None:
return None
# Check if synchronous WAL streaming can be enabled
# by peeking 'synchronous_standby_names'
postgres_status = postgres.get_remote_status()
syncnames = postgres_status["synchronous_standby_names"]
_logger.debug(
"Look for '%s' in 'synchronous_standby_names': %s",
self.config.streaming_archiver_name,
syncnames,
)
# The receive-wal process is eligible for synchronous replication
# if `synchronous_standby_names` is configured and contains
# the value of `streaming_archiver_name`
streaming_archiver_name = self.config.streaming_archiver_name
synchronous = syncnames and (
"*" in syncnames or streaming_archiver_name in syncnames
)
_logger.debug(
"Synchronous WAL streaming for %s: %s", streaming_archiver_name, synchronous
)
return synchronous
def status(self):
"""
Set additional status info - invoked by Server.status()
"""
# TODO: Add status information for WAL streaming
barman-2.18/barman/fs.py 0000644 0006212 0006212 00000035273 14172556763 013334 0 ustar 0000000 0000000 # -*- coding: utf-8 -*-
# © Copyright EnterpriseDB UK Limited 2013-2022
#
# This file is part of Barman.
#
# Barman is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Barman is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Barman. If not, see .
import logging
import re
from barman.command_wrappers import Command, full_command_quote
from barman.exceptions import FsOperationFailed
_logger = logging.getLogger(__name__)
class UnixLocalCommand(object):
"""
This class is a wrapper for local calls for file system operations
"""
def __init__(self, path=None):
# initialize a shell
self.internal_cmd = Command(cmd="sh", args=["-c"], path=path)
def cmd(self, cmd_name, args=[]):
"""
Execute a command string, escaping it, if necessary
"""
return self.internal_cmd(full_command_quote(cmd_name, args))
def get_last_output(self):
"""
Return the output and the error strings from the last executed command
:rtype: tuple[str,str]
"""
return self.internal_cmd.out, self.internal_cmd.err
def create_dir_if_not_exists(self, dir_path):
"""
This method recursively creates a directory if not exists
If the path exists and is not a directory raise an exception.
:param str dir_path: full path for the directory
"""
_logger.debug("Create directory %s if it does not exists" % dir_path)
exists = self.exists(dir_path)
if exists:
is_dir = self.cmd("test", args=["-d", dir_path])
if is_dir != 0:
raise FsOperationFailed("A file with the same name already exists")
else:
return False
else:
# Make parent directories if needed
mkdir_ret = self.cmd("mkdir", args=["-p", dir_path])
if mkdir_ret == 0:
return True
else:
raise FsOperationFailed("mkdir execution failed")
def delete_if_exists(self, path):
"""
This method check for the existence of a path.
If it exists, then is removed using a rm -fr command,
and returns True.
If the command fails an exception is raised.
If the path does not exists returns False
:param path the full path for the directory
"""
_logger.debug("Delete path %s if exists" % path)
exists = self.exists(path, False)
if exists:
rm_ret = self.cmd("rm", args=["-fr", path])
if rm_ret == 0:
return True
else:
raise FsOperationFailed("rm execution failed")
else:
return False
def check_directory_exists(self, dir_path):
"""
Check for the existence of a directory in path.
if the directory exists returns true.
if the directory does not exists returns false.
if exists a file and is not a directory raises an exception
:param dir_path full path for the directory
"""
_logger.debug("Check if directory %s exists" % dir_path)
exists = self.exists(dir_path)
if exists:
is_dir = self.cmd("test", args=["-d", dir_path])
if is_dir != 0:
raise FsOperationFailed(
"A file with the same name exists, but is not a directory"
)
else:
return True
else:
return False
def check_write_permission(self, dir_path):
"""
check write permission for barman on a given path.
Creates a hidden file using touch, then remove the file.
returns true if the file is written and removed without problems
raise exception if the creation fails.
raise exception if the removal fails.
:param dir_path full dir_path for the directory to check
"""
_logger.debug("Check if directory %s is writable" % dir_path)
exists = self.exists(dir_path)
if exists:
is_dir = self.cmd("test", args=["-d", dir_path])
if is_dir == 0:
can_write = self.cmd(
"touch", args=["%s/.barman_write_check" % dir_path]
)
if can_write == 0:
can_remove = self.cmd(
"rm", args=["%s/.barman_write_check" % dir_path]
)
if can_remove == 0:
return True
else:
raise FsOperationFailed("Unable to remove file")
else:
raise FsOperationFailed("Unable to create write check file")
else:
raise FsOperationFailed("%s is not a directory" % dir_path)
else:
raise FsOperationFailed("%s does not exists" % dir_path)
def create_symbolic_link(self, src, dst):
"""
Create a symlink pointing to src named dst.
Check src exists, if so, checks that destination
does not exists. if src is an invalid folder, raises an exception.
if dst already exists, raises an exception. if ln -s command fails
raises an exception
:param src full path to the source of the symlink
:param dst full path for the destination of the symlink
"""
_logger.debug("Create symbolic link %s -> %s" % (dst, src))
exists = self.exists(src)
if exists:
exists_dst = self.exists(dst)
if not exists_dst:
link = self.cmd("ln", args=["-s", src, dst])
if link == 0:
return True
else:
raise FsOperationFailed("ln command failed")
else:
raise FsOperationFailed("ln destination already exists")
else:
raise FsOperationFailed("ln source does not exists")
def get_system_info(self):
"""
Gather important system information for 'barman diagnose' command
"""
result = {}
# self.internal_cmd.out can be None. The str() call will ensure it
# will be translated to a literal 'None'
release = ""
if self.cmd("lsb_release", args=["-a"]) == 0:
release = self.internal_cmd.out.rstrip()
elif self.exists("/etc/lsb-release"):
self.cmd("cat", args=["/etc/lsb-release"])
release = "Ubuntu Linux %s" % self.internal_cmd.out.rstrip()
elif self.exists("/etc/debian_version"):
self.cmd("cat", args=["/etc/debian_version"])
release = "Debian GNU/Linux %s" % self.internal_cmd.out.rstrip()
elif self.exists("/etc/redhat-release"):
self.cmd("cat", args=["/etc/redhat-release"])
release = "RedHat Linux %s" % self.internal_cmd.out.rstrip()
elif self.cmd("sw_vers") == 0:
release = self.internal_cmd.out.rstrip()
result["release"] = release
self.cmd("uname", args=["-a"])
result["kernel_ver"] = self.internal_cmd.out.rstrip()
self.cmd("python", args=["--version", "2>&1"])
result["python_ver"] = self.internal_cmd.out.rstrip()
self.cmd("rsync", args=["--version", "2>&1"])
try:
result["rsync_ver"] = self.internal_cmd.out.splitlines(True)[0].rstrip()
except IndexError:
result["rsync_ver"] = ""
self.cmd("ssh", args=["-V", "2>&1"])
result["ssh_ver"] = self.internal_cmd.out.rstrip()
return result
def get_file_content(self, path):
"""
Retrieve the content of a file
If the file doesn't exist or isn't readable, it raises an exception.
:param str path: full path to the file to read
"""
_logger.debug("Reading content of file %s" % path)
result = self.exists(path)
if not result:
raise FsOperationFailed("The %s file does not exist" % path)
result = self.cmd("test", args=["-r", path])
if result != 0:
raise FsOperationFailed("The %s file is not readable" % path)
result = self.cmd("cat", args=[path])
if result != 0:
raise FsOperationFailed("Failed to execute \"cat '%s'\"" % path)
return self.internal_cmd.out
def exists(self, path, dereference=True):
"""
Check for the existence of a path.
:param str path: full path to check
:param bool dereference: whether dereference symlinks, defaults
to True
:return bool: if the file exists or not.
"""
_logger.debug("check for existence of: %s" % path)
options = ["-e", path]
if not dereference:
options += ["-o", "-L", path]
result = self.cmd("test", args=options)
return result == 0
def ping(self):
"""
'Ping' the server executing the `true` command.
:return int: the true cmd result
"""
_logger.debug("execute the true command")
result = self.cmd("true")
return result
def list_dir_content(self, dir_path, options=[]):
"""
List the contents of a given directory.
:param str dir_path: the path where we want the ls to be executed
:param list[str] options: a string containing the options for the ls
command
:return str: the ls cmd output
"""
_logger.debug("list the content of a directory")
ls_options = []
if options:
ls_options += options
ls_options.append(dir_path)
self.cmd("ls", args=ls_options)
return self.internal_cmd.out
class UnixRemoteCommand(UnixLocalCommand):
"""
This class is a wrapper for remote calls for file system operations
"""
# noinspection PyMissingConstructor
def __init__(self, ssh_command, ssh_options=None, path=None):
"""
Uses the same commands as the UnixLocalCommand
but the constructor is overridden and a remote shell is
initialized using the ssh_command provided by the user
:param str ssh_command: the ssh command provided by the user
:param list[str] ssh_options: the options to be passed to SSH
:param str path: the path to be used if provided, otherwise
the PATH environment variable will be used
"""
# Ensure that ssh_option is iterable
if ssh_options is None:
ssh_options = []
if ssh_command is None:
raise FsOperationFailed("No ssh command provided")
self.internal_cmd = Command(
ssh_command, args=ssh_options, path=path, shell=True
)
try:
ret = self.cmd("true")
except OSError:
raise FsOperationFailed("Unable to execute %s" % ssh_command)
if ret != 0:
raise FsOperationFailed(
"Connection failed using '%s %s' return code %s"
% (ssh_command, " ".join(ssh_options), ret)
)
def path_allowed(exclude, include, path, is_dir):
"""
Filter files based on include/exclude lists.
The rules are evaluated in steps:
1. if there are include rules and the proposed path match them, it
is immediately accepted.
2. if there are exclude rules and the proposed path match them, it
is immediately rejected.
3. the path is accepted.
Look at the documentation for the "evaluate_path_matching_rules" function
for more information about the syntax of the rules.
:param list[str]|None exclude: The list of rules composing the exclude list
:param list[str]|None include: The list of rules composing the include list
:param str path: The patch to patch
:param bool is_dir: True is the passed path is a directory
:return bool: True is the patch is accepted, False otherwise
"""
if include and _match_path(include, path, is_dir):
return True
if exclude and _match_path(exclude, path, is_dir):
return False
return True
def _match_path(rules, path, is_dir):
"""
Determine if a certain list of rules match a filesystem entry.
The rule-checking algorithm also handles rsync-like anchoring of rules
prefixed with '/'. If the rule is not anchored then it match every
file whose suffix matches the rule.
That means that a rule like 'a/b', will match 'a/b' and 'x/a/b' too.
A rule like '/a/b' will match 'a/b' but not 'x/a/b'.
If a rule ends with a slash (i.e. 'a/b/') if will be used only if the
passed path is a directory.
This function implements the basic wildcards. For more information about
that, consult the documentation of the "translate_to_regexp" function.
:param list[str] rules: match
:param path: the path of the entity to match
:param is_dir: True if the entity is a directory
:return bool:
"""
for rule in rules:
if rule[-1] == "/":
if not is_dir:
continue
rule = rule[:-1]
anchored = False
if rule[0] == "/":
rule = rule[1:]
anchored = True
if _wildcard_match_path(path, rule):
return True
if not anchored and _wildcard_match_path(path, "**/" + rule):
return True
return False
def _wildcard_match_path(path, pattern):
"""
Check if the proposed shell pattern match the path passed.
:param str path:
:param str pattern:
:rtype bool: True if it match, False otherwise
"""
regexp = re.compile(_translate_to_regexp(pattern))
return regexp.match(path) is not None
def _translate_to_regexp(pattern):
"""
Translate a shell PATTERN to a regular expression.
These wildcard characters you to use:
- "?" to match every character
- "*" to match zero or more characters, excluding "/"
- "**" to match zero or more characters, including "/"
There is no way to quote meta-characters.
This implementation is based on the one in the Python fnmatch module
:param str pattern: A string containing wildcards
"""
i, n = 0, len(pattern)
res = ""
while i < n:
c = pattern[i]
i = i + 1
if pattern[i - 1 :].startswith("**"):
res = res + ".*"
i = i + 1
elif c == "*":
res = res + "[^/]*"
elif c == "?":
res = res + "."
else:
res = res + re.escape(c)
return r"(?s)%s\Z" % res
barman-2.18/barman/annotations.py 0000644 0006212 0006212 00000030727 14172556763 015260 0 ustar 0000000 0000000 # -*- coding: utf-8 -*-
# © Copyright EnterpriseDB UK Limited 2011-2022
#
# This file is part of Barman.
#
# Barman is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Barman is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Barman. If not, see .
import errno
import io
import os
from abc import ABCMeta, abstractmethod
from barman.exceptions import ArchivalBackupException
from barman.utils import with_metaclass
class AnnotationManager(with_metaclass(ABCMeta)):
"""
This abstract base class defines the AnnotationManager interface which provides
methods for read, write and delete of annotations for a given backup.
"""
@abstractmethod
def put_annotation(self, backup_id, key, value):
"""Add an annotation"""
@abstractmethod
def get_annotation(self, backup_id, key):
"""Get the value of an annotation"""
@abstractmethod
def delete_annotation(self, backup_id, key):
"""Delete an annotation"""
class AnnotationManagerFile(AnnotationManager):
def __init__(self, path):
"""
Constructor for the file-based annotation manager.
Should be initialised with the path to the barman base backup directory.
"""
self.path = path
def _get_annotation_path(self, backup_id, key):
"""
Builds the annotation path for the specified backup_id and annotation key.
"""
return "%s/%s/annotations/%s" % (self.path, backup_id, key)
def delete_annotation(self, backup_id, key):
"""
Deletes an annotation from the filesystem for the specified backup_id and
annotation key.
"""
annotation_path = self._get_annotation_path(backup_id, key)
try:
os.remove(annotation_path)
except EnvironmentError as e:
# For Python 2 compatibility we must check the error code directly
# If the annotation doesn't exist then the failure to delete it is not an
# error condition and we should not proceed to remove the annotations
# directory
if e.errno == errno.ENOENT:
return
else:
raise
try:
os.rmdir(os.path.dirname(annotation_path))
except EnvironmentError as e:
# For Python 2 compatibility we must check the error code directly
# If we couldn't remove the directory because it wasn't empty then we
# do not consider it an error condition
if e.errno != errno.ENOTEMPTY:
raise
def get_annotation(self, backup_id, key):
"""
Reads the annotation `key` for the specified backup_id from the filesystem
and returns the value.
"""
annotation_path = self._get_annotation_path(backup_id, key)
try:
with open(annotation_path, "r") as annotation_file:
return annotation_file.read()
except EnvironmentError as e:
# For Python 2 compatibility we must check the error code directly
# If the annotation doesn't exist then return None
if e.errno != errno.ENOENT:
raise
def put_annotation(self, backup_id, key, value):
"""
Writes the specified value for annotation `key` for the specified backup_id
to the filesystem.
"""
annotation_path = self._get_annotation_path(backup_id, key)
try:
os.makedirs(os.path.dirname(annotation_path))
except EnvironmentError as e:
# For Python 2 compatibility we must check the error code directly
# If the directory already exists then it is not an error condition
if e.errno != errno.EEXIST:
raise
with open(annotation_path, "w") as annotation_file:
if value:
annotation_file.write(value)
class AnnotationManagerCloud(AnnotationManager):
def __init__(self, cloud_interface, server_name):
"""
Constructor for the cloud-based annotation manager.
Should be initialised with the CloudInterface and name of the server which
was used to create the backups.
"""
self.cloud_interface = cloud_interface
self.server_name = server_name
self.annotation_cache = None
def _get_base_path(self):
"""
Returns the base path to the cloud storage, accounting for the fact that
CloudInterface.path may be None.
"""
return self.cloud_interface.path and "%s/" % self.cloud_interface.path or ""
def _get_annotation_path(self, backup_id, key):
"""
Builds the full key to the annotation in cloud storage for the specified
backup_id and annotation key.
"""
return "%s%s/base/%s/annotations/%s" % (
self._get_base_path(),
self.server_name,
backup_id,
key,
)
def _populate_annotation_cache(self):
"""
Build a cache of which annotations actually exist by walking the bucket.
This allows us to optimize get_annotation by just checking a (backup_id,key)
tuple here which is cheaper (in time and money) than going to the cloud
every time.
"""
self.annotation_cache = {}
for object_key in self.cloud_interface.list_bucket(
os.path.join(self._get_base_path(), self.server_name, "base") + "/",
delimiter="",
):
key_parts = object_key.split("/")
if len(key_parts) > 3:
if key_parts[-2] == "annotations":
backup_id = key_parts[-3]
annotation_key = key_parts[-1]
self.annotation_cache[(backup_id, annotation_key)] = True
def delete_annotation(self, backup_id, key):
"""
Deletes an annotation from cloud storage for the specified backup_id and
annotation key.
"""
annotation_path = self._get_annotation_path(backup_id, key)
self.cloud_interface.delete_objects([annotation_path])
def get_annotation(self, backup_id, key, use_cache=True):
"""
Reads the annotation `key` for the specified backup_id from cloud storage
and returns the value.
The default behaviour is that, when it is first run, it populates a
cache of the annotations which exist for each backup by walking the
bucket. Subsequent operations can check that cache and avoid having to
call remote_open if an annotation is not found in the cache.
This optimises for the case where annotations are sparse and assumes the
cost of walking the bucket is less than the cost of the remote_open calls
which would not return a value.
In cases where we do not want to walk the bucket up front then the caching
can be disabled.
"""
# Optimize for the most common case where there is no annotation
if use_cache:
if self.annotation_cache is None:
self._populate_annotation_cache()
if (
self.annotation_cache is not None
and (backup_id, key) not in self.annotation_cache
):
return None
# We either know there's an annotation or we havn't used the cache so read
# it from the cloud
annotation_path = self._get_annotation_path(backup_id, key)
annotation_fileobj = self.cloud_interface.remote_open(annotation_path)
if annotation_fileobj:
with annotation_fileobj:
annotation_bytes = annotation_fileobj.readline()
return annotation_bytes.decode("utf-8")
else:
# We intentionally return None if remote_open found nothing
return None
def put_annotation(self, backup_id, key, value):
"""
Writes the specified value for annotation `key` for the specified backup_id
to cloud storage.
"""
annotation_path = self._get_annotation_path(backup_id, key)
self.cloud_interface.upload_fileobj(
io.BytesIO(value.encode("utf-8")), annotation_path
)
class KeepManager(with_metaclass(ABCMeta, object)):
"""Abstract base class which defines the KeepManager interface"""
ANNOTATION_KEY = "keep"
TARGET_FULL = "full"
TARGET_STANDALONE = "standalone"
supported_targets = (TARGET_FULL, TARGET_STANDALONE)
@abstractmethod
def should_keep_backup(self, backup_id):
pass
@abstractmethod
def keep_backup(self, backup_id, target):
pass
@abstractmethod
def get_keep_target(self, backup_id):
pass
@abstractmethod
def release_keep(self, backup_id):
pass
class KeepManagerMixin(KeepManager):
"""
A Mixin which adds KeepManager functionality to its subclasses.
Keep management is built on top of annotations and consists of the
following functionality:
- Determine whether a given backup is intended to be kept beyond its retention
period.
- Determine the intended recovery target for the archival backup.
- Add and remove the keep annotation.
The functionality is implemented as a Mixin so that it can be used to add
keep management to the backup management class in barman (BackupManager)
as well as its closest analog in barman-cloud (CloudBackupCatalog).
"""
def __init__(self, *args, **kwargs):
"""
Base constructor (Mixin pattern).
kwargs must contain *either*:
- A barman.server.Server object with the key `server`, *or*:
- A CloudInterface object and a server name, keys `cloud_interface` and
`server_name` respectively.
"""
if "server" in kwargs:
server = kwargs.pop("server")
self.annotation_manager = AnnotationManagerFile(
server.config.basebackups_directory
)
elif "cloud_interface" in kwargs:
self.annotation_manager = AnnotationManagerCloud(
kwargs.pop("cloud_interface"), kwargs.pop("server_name")
)
super(KeepManagerMixin, self).__init__(*args, **kwargs)
def should_keep_backup(self, backup_id):
"""
Returns True if the specified backup_id for this server has a keep annotation.
False otherwise.
"""
return (
self.annotation_manager.get_annotation(backup_id, type(self).ANNOTATION_KEY)
is not None
)
def keep_backup(self, backup_id, target):
"""
Add a keep annotation for backup with ID backup_id with the specified
recovery target.
"""
if target not in KeepManagerMixin.supported_targets:
raise ArchivalBackupException("Unsupported recovery target: %s" % target)
self.annotation_manager.put_annotation(
backup_id, type(self).ANNOTATION_KEY, target
)
def get_keep_target(self, backup_id):
"""Retrieve the intended recovery target"""
return self.annotation_manager.get_annotation(
backup_id, type(self).ANNOTATION_KEY
)
def release_keep(self, backup_id):
"""Release the keep annotation"""
self.annotation_manager.delete_annotation(backup_id, type(self).ANNOTATION_KEY)
class KeepManagerMixinCloud(KeepManagerMixin):
"""
A specialised KeepManager which allows the annotation caching optimization in
the AnnotationManagerCloud backend to be optionally disabled.
"""
def should_keep_backup(self, backup_id, use_cache=True):
"""
Like KeepManagerMixinCloud.should_keep_backup but with the use_cache option.
"""
return (
self.annotation_manager.get_annotation(
backup_id, type(self).ANNOTATION_KEY, use_cache=use_cache
)
is not None
)
def get_keep_target(self, backup_id, use_cache=True):
"""
Like KeepManagerMixinCloud.get_keep_target but with the use_cache option.
"""
return self.annotation_manager.get_annotation(
backup_id, type(self).ANNOTATION_KEY, use_cache=use_cache
)
barman-2.18/barman/command_wrappers.py 0000644 0006212 0006212 00000122635 14172556763 016264 0 ustar 0000000 0000000 # -*- coding: utf-8 -*-
# © Copyright EnterpriseDB UK Limited 2011-2022
#
# This file is part of Barman.
#
# Barman is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Barman is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Barman. If not, see .
"""
This module contains a wrapper for shell commands
"""
from __future__ import print_function
import errno
import inspect
import logging
import os
import re
import select
import signal
import subprocess
import sys
import time
from distutils.version import LooseVersion as Version
import barman.utils
from barman.exceptions import CommandFailedException, CommandMaxRetryExceeded
_logger = logging.getLogger(__name__)
class StreamLineProcessor(object):
"""
Class deputed to reading lines from a file object, using a buffered read.
NOTE: This class never call os.read() twice in a row. And is designed to
work with the select.select() method.
"""
def __init__(self, fobject, handler):
"""
:param file fobject: The file that is being read
:param callable handler: The function (taking only one unicode string
argument) which will be called for every line
"""
self._file = fobject
self._handler = handler
self._buf = ""
def fileno(self):
"""
Method used by select.select() to get the underlying file descriptor.
:rtype: the underlying file descriptor
"""
return self._file.fileno()
def process(self):
"""
Read the ready data from the stream and for each line found invoke the
handler.
:return bool: True when End Of File has been reached
"""
data = os.read(self._file.fileno(), 4096)
# If nothing has been read, we reached the EOF
if not data:
self._file.close()
# Handle the last line (always incomplete, maybe empty)
self._handler(self._buf)
return True
self._buf += data.decode("utf-8", "replace")
# If no '\n' is present, we just read a part of a very long line.
# Nothing to do at the moment.
if "\n" not in self._buf:
return False
tmp = self._buf.split("\n")
# Leave the remainder in self._buf
self._buf = tmp[-1]
# Call the handler for each complete line.
lines = tmp[:-1]
for line in lines:
self._handler(line)
return False
class Command(object):
"""
Wrapper for a system command
"""
def __init__(
self,
cmd,
args=None,
env_append=None,
path=None,
shell=False,
check=False,
allowed_retval=(0,),
close_fds=True,
out_handler=None,
err_handler=None,
retry_times=0,
retry_sleep=0,
retry_handler=None,
):
"""
If the `args` argument is specified the arguments will be always added
to the ones eventually passed with the actual invocation.
If the `env_append` argument is present its content will be appended to
the environment of every invocation.
The subprocess output and error stream will be processed through
the output and error handler, respectively defined through the
`out_handler` and `err_handler` arguments. If not provided every line
will be sent to the log respectively at INFO and WARNING level.
The `out_handler` and the `err_handler` functions will be invoked with
one single argument, which is a string containing the line that is
being processed.
If the `close_fds` argument is True, all file descriptors
except 0, 1 and 2 will be closed before the child process is executed.
If the `check` argument is True, the exit code will be checked
against the `allowed_retval` list, raising a CommandFailedException if
not in the list.
If `retry_times` is greater than 0, when the execution of a command
terminates with an error, it will be retried for
a maximum of `retry_times` times, waiting for `retry_sleep` seconds
between every attempt.
Every time a command is retried the `retry_handler` is executed
before running the command again. The retry_handler must be a callable
that accepts the following fields:
* the Command object
* the arguments list
* the keyword arguments dictionary
* the number of the failed attempt
* the exception containing the error
An example of such a function is:
> def retry_handler(command, args, kwargs, attempt, exc):
> print("Failed command!")
Some of the keyword arguments can be specified both in the class
constructor and during the method call. If specified in both places,
the method arguments will take the precedence over
the constructor arguments.
:param str cmd: The command to execute
:param list[str]|None args: List of additional arguments to append
:param dict[str.str]|None env_append: additional environment variables
:param str path: PATH to be used while searching for `cmd`
:param bool shell: If true, use the shell instead of an "execve" call
:param bool check: Raise a CommandFailedException if the exit code
is not present in `allowed_retval`
:param list[int] allowed_retval: List of exit codes considered as a
successful termination.
:param bool close_fds: If set, close all the extra file descriptors
:param callable out_handler: handler for lines sent on stdout
:param callable err_handler: handler for lines sent on stderr
:param int retry_times: number of allowed retry attempts
:param int retry_sleep: wait seconds between every retry
:param callable retry_handler: handler invoked during a command retry
"""
self.pipe = None
self.cmd = cmd
self.args = args if args is not None else []
self.shell = shell
self.close_fds = close_fds
self.check = check
self.allowed_retval = allowed_retval
self.retry_times = retry_times
self.retry_sleep = retry_sleep
self.retry_handler = retry_handler
self.path = path
self.ret = None
self.out = None
self.err = None
# If env_append has been provided use it or replace with an empty dict
env_append = env_append or {}
# If path has been provided, replace it in the environment
if path:
env_append["PATH"] = path
# Find the absolute path to the command to execute
if not self.shell:
full_path = barman.utils.which(self.cmd, self.path)
if not full_path:
raise CommandFailedException("%s not in PATH" % self.cmd)
self.cmd = full_path
# If env_append contains anything, build an env dict to be used during
# subprocess call, otherwise set it to None and let the subprocesses
# inherit the parent environment
if env_append:
self.env = os.environ.copy()
self.env.update(env_append)
else:
self.env = None
# If an output handler has been provided use it, otherwise log the
# stdout as INFO
if out_handler:
self.out_handler = out_handler
else:
self.out_handler = self.make_logging_handler(logging.INFO)
# If an error handler has been provided use it, otherwise log the
# stderr as WARNING
if err_handler:
self.err_handler = err_handler
else:
self.err_handler = self.make_logging_handler(logging.WARNING)
@staticmethod
def _restore_sigpipe():
"""restore default signal handler (http://bugs.python.org/issue1652)"""
signal.signal(signal.SIGPIPE, signal.SIG_DFL) # pragma: no cover
def __call__(self, *args, **kwargs):
"""
Run the command and return the exit code.
The output and error strings are not returned, but they can be accessed
as attributes of the Command object, as well as the exit code.
If `stdin` argument is specified, its content will be passed to the
executed command through the standard input descriptor.
If the `close_fds` argument is True, all file descriptors
except 0, 1 and 2 will be closed before the child process is executed.
If the `check` argument is True, the exit code will be checked
against the `allowed_retval` list, raising a CommandFailedException if
not in the list.
Every keyword argument can be specified both in the class constructor
and during the method call. If specified in both places,
the method arguments will take the precedence over
the constructor arguments.
:rtype: int
:raise: CommandFailedException
:raise: CommandMaxRetryExceeded
"""
self.get_output(*args, **kwargs)
return self.ret
def get_output(self, *args, **kwargs):
"""
Run the command and return the output and the error as a tuple.
The return code is not returned, but it can be accessed as an attribute
of the Command object, as well as the output and the error strings.
If `stdin` argument is specified, its content will be passed to the
executed command through the standard input descriptor.
If the `close_fds` argument is True, all file descriptors
except 0, 1 and 2 will be closed before the child process is executed.
If the `check` argument is True, the exit code will be checked
against the `allowed_retval` list, raising a CommandFailedException if
not in the list.
Every keyword argument can be specified both in the class constructor
and during the method call. If specified in both places,
the method arguments will take the precedence over
the constructor arguments.
:rtype: tuple[str, str]
:raise: CommandFailedException
:raise: CommandMaxRetryExceeded
"""
attempt = 0
while True:
try:
return self._get_output_once(*args, **kwargs)
except CommandFailedException as exc:
# Try again if retry number is lower than the retry limit
if attempt < self.retry_times:
# If a retry_handler is defined, invoke it passing the
# Command instance and the exception
if self.retry_handler:
self.retry_handler(self, args, kwargs, attempt, exc)
# Sleep for configured time, then try again
time.sleep(self.retry_sleep)
attempt += 1
else:
if attempt == 0:
# No retry requested by the user
# Raise the original exception
raise
else:
# If the max number of attempts is reached and
# there is still an error, exit raising
# a CommandMaxRetryExceeded exception and wrap the
# original one
raise CommandMaxRetryExceeded(*exc.args)
def _get_output_once(self, *args, **kwargs):
"""
Run the command and return the output and the error as a tuple.
The return code is not returned, but it can be accessed as an attribute
of the Command object, as well as the output and the error strings.
If `stdin` argument is specified, its content will be passed to the
executed command through the standard input descriptor.
If the `close_fds` argument is True, all file descriptors
except 0, 1 and 2 will be closed before the child process is executed.
If the `check` argument is True, the exit code will be checked
against the `allowed_retval` list, raising a CommandFailedException if
not in the list.
Every keyword argument can be specified both in the class constructor
and during the method call. If specified in both places,
the method arguments will take the precedence over
the constructor arguments.
:rtype: tuple[str, str]
:raises: CommandFailedException
"""
out = []
err = []
# If check is true, it must be handled here
check = kwargs.pop("check", self.check)
allowed_retval = kwargs.pop("allowed_retval", self.allowed_retval)
self.execute(
out_handler=out.append, err_handler=err.append, check=False, *args, **kwargs
)
self.out = "\n".join(out)
self.err = "\n".join(err)
_logger.debug("Command stdout: %s", self.out)
_logger.debug("Command stderr: %s", self.err)
# Raise if check and the return code is not in the allowed list
if check:
self.check_return_value(allowed_retval)
return self.out, self.err
def check_return_value(self, allowed_retval):
"""
Check the current return code and raise CommandFailedException when
it's not in the allowed_retval list
:param list[int] allowed_retval: list of return values considered
success
:raises: CommandFailedException
"""
if self.ret not in allowed_retval:
raise CommandFailedException(dict(ret=self.ret, out=self.out, err=self.err))
def execute(self, *args, **kwargs):
"""
Execute the command and pass the output to the configured handlers
If `stdin` argument is specified, its content will be passed to the
executed command through the standard input descriptor.
The subprocess output and error stream will be processed through
the output and error handler, respectively defined through the
`out_handler` and `err_handler` arguments. If not provided every line
will be sent to the log respectively at INFO and WARNING level.
If the `close_fds` argument is True, all file descriptors
except 0, 1 and 2 will be closed before the child process is executed.
If the `check` argument is True, the exit code will be checked
against the `allowed_retval` list, raising a CommandFailedException if
not in the list.
Every keyword argument can be specified both in the class constructor
and during the method call. If specified in both places,
the method arguments will take the precedence over
the constructor arguments.
:rtype: int
:raise: CommandFailedException
"""
# Check keyword arguments
stdin = kwargs.pop("stdin", None)
check = kwargs.pop("check", self.check)
allowed_retval = kwargs.pop("allowed_retval", self.allowed_retval)
close_fds = kwargs.pop("close_fds", self.close_fds)
out_handler = kwargs.pop("out_handler", self.out_handler)
err_handler = kwargs.pop("err_handler", self.err_handler)
if len(kwargs):
raise TypeError(
"%s() got an unexpected keyword argument %r"
% (inspect.stack()[1][3], kwargs.popitem()[0])
)
# Reset status
self.ret = None
self.out = None
self.err = None
# Create the subprocess and save it in the current object to be usable
# by signal handlers
pipe = self._build_pipe(args, close_fds)
self.pipe = pipe
# Send the provided input and close the stdin descriptor
if stdin:
pipe.stdin.write(stdin)
pipe.stdin.close()
# Prepare the list of processors
processors = [
StreamLineProcessor(pipe.stdout, out_handler),
StreamLineProcessor(pipe.stderr, err_handler),
]
# Read the streams until the subprocess exits
self.pipe_processor_loop(processors)
# Reap the zombie and read the exit code
pipe.wait()
self.ret = pipe.returncode
# Remove the closed pipe from the object
self.pipe = None
_logger.debug("Command return code: %s", self.ret)
# Raise if check and the return code is not in the allowed list
if check:
self.check_return_value(allowed_retval)
return self.ret
def _build_pipe(self, args, close_fds):
"""
Build the Pipe object used by the Command
The resulting command will be composed by:
self.cmd + self.args + args
:param args: extra arguments for the subprocess
:param close_fds: if True all file descriptors except 0, 1 and 2
will be closed before the child process is executed.
:rtype: subprocess.Popen
"""
# Append the argument provided to this method of the base argument list
args = self.args + list(args)
# If shell is True, properly quote the command
if self.shell:
cmd = full_command_quote(self.cmd, args)
else:
cmd = [self.cmd] + args
# Log the command we are about to execute
_logger.debug("Command: %r", cmd)
return subprocess.Popen(
cmd,
shell=self.shell,
env=self.env,
stdin=subprocess.PIPE,
stdout=subprocess.PIPE,
stderr=subprocess.PIPE,
preexec_fn=self._restore_sigpipe,
close_fds=close_fds,
)
@staticmethod
def pipe_processor_loop(processors):
"""
Process the output received through the pipe until all the provided
StreamLineProcessor reach the EOF.
:param list[StreamLineProcessor] processors: a list of
StreamLineProcessor
"""
# Loop until all the streams reaches the EOF
while processors:
try:
ready = select.select(processors, [], [])[0]
except select.error as e:
# If the select call has been interrupted by a signal
# just retry
if e.args[0] == errno.EINTR:
continue
raise
# For each ready StreamLineProcessor invoke the process() method
for stream in ready:
eof = stream.process()
# Got EOF on this stream
if eof:
# Remove the stream from the list of valid processors
processors.remove(stream)
@classmethod
def make_logging_handler(cls, level, prefix=None):
"""
Build a handler function that logs every line it receives.
The resulting function logs its input at the specified level
with an optional prefix.
:param level: The log level to use
:param prefix: An optional prefix to prepend to the line
:return: handler function
"""
class_logger = logging.getLogger(cls.__name__)
def handler(line):
if line:
if prefix:
class_logger.log(level, "%s%s", prefix, line)
else:
class_logger.log(level, "%s", line)
return handler
@staticmethod
def make_output_handler(prefix=None):
"""
Build a handler function which prints every line it receives.
The resulting function prints (and log it at INFO level) its input
with an optional prefix.
:param prefix: An optional prefix to prepend to the line
:return: handler function
"""
# Import the output module inside the function to avoid circular
# dependency
from barman import output
def handler(line):
if line:
if prefix:
output.info("%s%s", prefix, line)
else:
output.info("%s", line)
return handler
def enable_signal_forwarding(self, signal_id):
"""
Enable signal forwarding to the subprocess for a specified signal_id
:param signal_id: The signal id to be forwarded
"""
# Get the current signal handler
old_handler = signal.getsignal(signal_id)
def _handler(sig, frame):
"""
This signal handler forward the signal to the subprocess then
execute the original handler.
"""
# Forward the signal to the subprocess
if self.pipe:
self.pipe.send_signal(signal_id)
# If the old handler is callable
if callable(old_handler):
old_handler(sig, frame)
# If we have got a SIGTERM, we must exit
elif old_handler == signal.SIG_DFL and signal_id == signal.SIGTERM:
sys.exit(128 + signal_id)
# Set the signal handler
signal.signal(signal_id, _handler)
class Rsync(Command):
"""
This class is a wrapper for the rsync system command,
which is used vastly by barman
"""
def __init__(
self,
rsync="rsync",
args=None,
ssh=None,
ssh_options=None,
bwlimit=None,
exclude=None,
exclude_and_protect=None,
include=None,
network_compression=None,
path=None,
**kwargs
):
"""
:param str rsync: rsync executable name
:param list[str]|None args: List of additional argument to always
append
:param str ssh: the ssh executable to be used when building
the `-e` argument
:param list[str] ssh_options: the ssh options to be used when building
the `-e` argument
:param str bwlimit: optional bandwidth limit
:param list[str] exclude: list of file to be excluded from the copy
:param list[str] exclude_and_protect: list of file to be excluded from
the copy, preserving the destination if exists
:param list[str] include: list of files to be included in the copy
even if excluded.
:param bool network_compression: enable the network compression
:param str path: PATH to be used while searching for `cmd`
:param bool check: Raise a CommandFailedException if the exit code
is not present in `allowed_retval`
:param list[int] allowed_retval: List of exit codes considered as a
successful termination.
"""
options = []
if ssh:
options += ["-e", full_command_quote(ssh, ssh_options)]
if network_compression:
options += ["-z"]
# Include patterns must be before the exclude ones, because the exclude
# patterns actually short-circuit the directory traversal stage
# when rsync finds the files to send.
if include:
for pattern in include:
options += ["--include=%s" % (pattern,)]
if exclude:
for pattern in exclude:
options += ["--exclude=%s" % (pattern,)]
if exclude_and_protect:
for pattern in exclude_and_protect:
options += ["--exclude=%s" % (pattern,), "--filter=P_%s" % (pattern,)]
if args:
options += self._args_for_suse(args)
if bwlimit is not None and bwlimit > 0:
options += ["--bwlimit=%s" % bwlimit]
# By default check is on and the allowed exit code are 0 and 24
if "check" not in kwargs:
kwargs["check"] = True
if "allowed_retval" not in kwargs:
kwargs["allowed_retval"] = (0, 24)
Command.__init__(self, rsync, args=options, path=path, **kwargs)
def _args_for_suse(self, args):
"""
Mangle args for SUSE compatibility
See https://bugzilla.opensuse.org/show_bug.cgi?id=898513
"""
# Prepend any argument starting with ':' with a space
# Workaround for SUSE rsync issue
return [" " + a if a.startswith(":") else a for a in args]
def get_output(self, *args, **kwargs):
"""
Run the command and return the output and the error (if present)
"""
# Prepares args for SUSE
args = self._args_for_suse(args)
# Invoke the base class method
return super(Rsync, self).get_output(*args, **kwargs)
def from_file_list(self, filelist, src, dst, *args, **kwargs):
"""
This method copies filelist from src to dst.
Returns the return code of the rsync command
"""
if "stdin" in kwargs:
raise TypeError("from_file_list() doesn't support 'stdin' keyword argument")
input_string = ("\n".join(filelist)).encode("UTF-8")
_logger.debug("from_file_list: %r", filelist)
kwargs["stdin"] = input_string
self.get_output("--files-from=-", src, dst, *args, **kwargs)
return self.ret
class RsyncPgData(Rsync):
"""
This class is a wrapper for rsync, specialised in sync-ing the
Postgres data directory
"""
def __init__(self, rsync="rsync", args=None, **kwargs):
"""
Constructor
:param str rsync: command to run
"""
options = ["-rLKpts", "--delete-excluded", "--inplace"]
if args:
options += args
Rsync.__init__(self, rsync, args=options, **kwargs)
class PostgreSQLClient(Command):
"""
Superclass of all the PostgreSQL client commands.
"""
COMMAND_ALTERNATIVES = None
"""
Sometimes the name of a command has been changed during the PostgreSQL
evolution. I.e. that happened with pg_receivexlog, that has been renamed
to pg_receivewal. In that case, we should try using pg_receivewal (the
newer auternative) and, if that command doesn't exist, we should try
using `pg_receivexlog`.
This is a list of command names to be used to find the installed command.
"""
def __init__(
self, connection, command, version=None, app_name=None, path=None, **kwargs
):
"""
Constructor
:param PostgreSQL connection: an object representing
a database connection
:param str command: the command to use
:param Version version: the command version
:param str app_name: the application name to use for the connection
:param str path: additional path for executable retrieval
"""
Command.__init__(self, command, path=path, **kwargs)
if not connection:
self.enable_signal_forwarding(signal.SIGINT)
self.enable_signal_forwarding(signal.SIGTERM)
return
if version and version >= Version("9.3"):
# If version of the client is >= 9.3 we use the connection
# string because allows the user to use all the parameters
# supported by the libpq library to create a connection
conn_string = connection.get_connection_string(app_name)
self.args.append("--dbname=%s" % conn_string)
else:
# 9.2 version doesn't support
# connection strings so the 'split' version of the conninfo
# option is used instead.
conn_params = connection.conn_parameters
self.args.append("--host=%s" % conn_params.get("host", None))
self.args.append("--port=%s" % conn_params.get("port", None))
self.args.append("--username=%s" % conn_params.get("user", None))
self.enable_signal_forwarding(signal.SIGINT)
self.enable_signal_forwarding(signal.SIGTERM)
@classmethod
def find_command(cls, path=None):
"""
Find the active command, given all the alternatives as set in the
property named `COMMAND_ALTERNATIVES` in this class.
:param str path: The path to use while searching for the command
:rtype: Command
"""
# TODO: Unit tests of this one
# To search for an available command, testing if the command
# exists in PATH is not sufficient. Debian will install wrappers for
# all commands, even if the real command doesn't work.
#
# I.e. we may have a wrapper for `pg_receivewal` even it PostgreSQL
# 10 isn't installed.
#
# This is an example of what can happen in this case:
#
# ```
# $ pg_receivewal --version; echo $?
# Error: pg_wrapper: pg_receivewal was not found in
# /usr/lib/postgresql/9.6/bin
# 1
# $ pg_receivexlog --version; echo $?
# pg_receivexlog (PostgreSQL) 9.6.3
# 0
# ```
#
# That means we should not only ensure the existence of the command,
# but we also need to invoke the command to see if it is a shim
# or not.
# Get the system path if needed
if path is None:
path = os.getenv("PATH")
# If the path is None at this point we have nothing to search
if path is None:
path = ""
# Search the requested executable in every directory present
# in path and return a Command object first occurrence that exists,
# is executable and runs without errors.
for path_entry in path.split(os.path.pathsep):
for cmd in cls.COMMAND_ALTERNATIVES:
full_path = barman.utils.which(cmd, path_entry)
# It doesn't exist try another
if not full_path:
continue
# It exists, let's try invoking it with `--version` to check if
# it's real or not.
try:
command = Command(full_path, path=path, check=True)
command("--version")
return command
except CommandFailedException:
# It's only a inactive shim
continue
# We don't have such a command
raise CommandFailedException(
"command not in PATH, tried: %s" % " ".join(cls.COMMAND_ALTERNATIVES)
)
@classmethod
def get_version_info(cls, path=None):
"""
Return a dictionary containing all the info about
the version of the PostgreSQL client
:param str path: the PATH env
"""
if cls.COMMAND_ALTERNATIVES is None:
raise NotImplementedError(
"get_version_info cannot be invoked on %s" % cls.__name__
)
version_info = dict.fromkeys(
("full_path", "full_version", "major_version"), None
)
# Get the version string
try:
command = cls.find_command(path)
except CommandFailedException as e:
_logger.debug("Error invoking %s: %s", cls.__name__, e)
return version_info
version_info["full_path"] = command.cmd
# Parse the full text version
try:
full_version = command.out.strip()
# Remove values inside parenthesis, they
# carries additional information we do not need.
full_version = re.sub(r"\s*\([^)]*\)", "", full_version)
full_version = full_version.split()[1]
except IndexError:
_logger.debug("Error parsing %s version output", version_info["full_path"])
return version_info
if not re.match(r"(\d+)(\.(\d+)|devel|beta|alpha|rc).*", full_version):
_logger.debug("Error parsing %s version output", version_info["full_path"])
return version_info
# Extract the major version
version_info["full_version"] = Version(full_version)
version_info["major_version"] = Version(
barman.utils.simplify_version(full_version)
)
return version_info
class PgBaseBackup(PostgreSQLClient):
"""
Wrapper class for the pg_basebackup system command
"""
COMMAND_ALTERNATIVES = ["pg_basebackup"]
def __init__(
self,
connection,
destination,
command,
version=None,
app_name=None,
bwlimit=None,
tbs_mapping=None,
immediate=False,
check=True,
args=None,
**kwargs
):
"""
Constructor
:param PostgreSQL connection: an object representing
a database connection
:param str destination: destination directory path
:param str command: the command to use
:param Version version: the command version
:param str app_name: the application name to use for the connection
:param str bwlimit: bandwidth limit for pg_basebackup
:param Dict[str, str] tbs_mapping: used for tablespace
:param bool immediate: fast checkpoint identifier for pg_basebackup
:param bool check: check if the return value is in the list of
allowed values of the Command obj
:param List[str] args: additional arguments
"""
PostgreSQLClient.__init__(
self,
connection=connection,
command=command,
version=version,
app_name=app_name,
check=check,
**kwargs
)
# Set the backup destination
self.args += ["-v", "--no-password", "--pgdata=%s" % destination]
if version and version >= Version("10"):
# If version of the client is >= 10 it would use
# a temporary replication slot by default to keep WALs.
# We don't need it because Barman already stores the full
# WAL stream, so we disable this feature to avoid wasting one slot.
self.args += ["--no-slot"]
# We also need to specify that we do not want to fetch any WAL file
self.args += ["--wal-method=none"]
# The tablespace mapping option is repeated once for each tablespace
if tbs_mapping:
for (tbs_source, tbs_destination) in tbs_mapping.items():
self.args.append(
"--tablespace-mapping=%s=%s" % (tbs_source, tbs_destination)
)
# Only global bandwidth limit is supported
if bwlimit is not None and bwlimit > 0:
self.args.append("--max-rate=%s" % bwlimit)
# Immediate checkpoint
if immediate:
self.args.append("--checkpoint=fast")
# Manage additional args
if args:
self.args += args
class PgReceiveXlog(PostgreSQLClient):
"""
Wrapper class for pg_receivexlog
"""
COMMAND_ALTERNATIVES = ["pg_receivewal", "pg_receivexlog"]
def __init__(
self,
connection,
destination,
command,
version=None,
app_name=None,
synchronous=False,
check=True,
slot_name=None,
args=None,
**kwargs
):
"""
Constructor
:param PostgreSQL connection: an object representing
a database connection
:param str destination: destination directory path
:param str command: the command to use
:param Version version: the command version
:param str app_name: the application name to use for the connection
:param bool synchronous: request synchronous WAL streaming
:param bool check: check if the return value is in the list of
allowed values of the Command obj
:param str slot_name: the replication slot name to use for the
connection
:param List[str] args: additional arguments
"""
PostgreSQLClient.__init__(
self,
connection=connection,
command=command,
version=version,
app_name=app_name,
check=check,
**kwargs
)
self.args += [
"--verbose",
"--no-loop",
"--no-password",
"--directory=%s" % destination,
]
# Add the replication slot name if set in the configuration.
if slot_name is not None:
self.args.append("--slot=%s" % slot_name)
# Request synchronous mode
if synchronous:
self.args.append("--synchronous")
# Manage additional args
if args:
self.args += args
class PgVerifyBackup(PostgreSQLClient):
"""
Wrapper class for the pg_verify system command
"""
COMMAND_ALTERNATIVES = ["pg_verifybackup"]
def __init__(
self,
data_path,
command,
connection=None,
version=None,
app_name=None,
check=True,
args=None,
**kwargs
):
"""
Constructor
:param str data_path: backup data directory
:param str command: the command to use
:param PostgreSQL connection: an object representing
a database connection
:param Version version: the command version
:param str app_name: the application name to use for the connection
:param bool check: check if the return value is in the list of
allowed values of the Command obj
:param List[str] args: additional arguments
"""
PostgreSQLClient.__init__(
self,
connection=connection,
command=command,
version=version,
app_name=app_name,
check=check,
**kwargs
)
self.args = ["-n", data_path]
if args:
self.args += args
class BarmanSubProcess(object):
"""
Wrapper class for barman sub instances
"""
def __init__(
self,
command=sys.argv[0],
subcommand=None,
config=None,
args=None,
keep_descriptors=False,
):
"""
Build a specific wrapper for all the barman sub-commands,
providing a unified interface.
:param str command: path to barman
:param str subcommand: the barman sub-command
:param str config: path to the barman configuration file.
:param list[str] args: a list containing the sub-command args
like the target server name
:param bool keep_descriptors: whether to keep the subprocess stdin,
stdout, stderr descriptors attached. Defaults to False
"""
# The config argument is needed when the user explicitly
# passes a configuration file, as the child process
# must know the configuration file to use.
#
# The configuration file must always be propagated,
# even in case of the default one.
if not config:
raise CommandFailedException(
"No configuration file passed to barman subprocess"
)
# Build the sub-command:
# * be sure to run it with the right python interpreter
# * pass the current configuration file with -c
# * set it quiet with -q
self.command = [sys.executable, command, "-c", config, "-q", subcommand]
self.keep_descriptors = keep_descriptors
# Handle args for the sub-command (like the server name)
if args:
self.command += args
def execute(self):
"""
Execute the command and pass the output to the configured handlers
"""
_logger.debug("BarmanSubProcess: %r", self.command)
# Redirect all descriptors to /dev/null
devnull = open(os.devnull, "a+")
additional_arguments = {}
if not self.keep_descriptors:
additional_arguments = {"stdout": devnull, "stderr": devnull}
proc = subprocess.Popen(
self.command,
preexec_fn=os.setsid,
close_fds=True,
stdin=devnull,
**additional_arguments
)
_logger.debug("BarmanSubProcess: subprocess started. pid: %s", proc.pid)
def shell_quote(arg):
"""
Quote a string argument to be safely included in a shell command line.
:param str arg: The script argument
:return: The argument quoted
"""
# This is an excerpt of the Bash manual page, and the same applies for
# every Posix compliant shell:
#
# A non-quoted backslash (\) is the escape character. It preserves
# the literal value of the next character that follows, with the
# exception of . If a \ pair appears, and the
# backslash is not itself quoted, the \ is treated as a
# line continuation (that is, it is removed from the input
# stream and effectively ignored).
#
# Enclosing characters in single quotes preserves the literal value
# of each character within the quotes. A single quote may not occur
# between single quotes, even when pre-ceded by a backslash.
#
# This means that, as long as the original string doesn't contain any
# apostrophe character, it can be safely included between single quotes.
#
# If a single quote is contained in the string, we must terminate the
# string with a quote, insert an apostrophe character escaping it with
# a backslash, and then start another string using a quote character.
assert arg is not None
return "'%s'" % arg.replace("'", "'\\''")
def full_command_quote(command, args=None):
"""
Produce a command with quoted arguments
:param str command: the command to be executed
:param list[str] args: the command arguments
:rtype: str
"""
if args is not None and len(args) > 0:
return "%s %s" % (command, " ".join([shell_quote(arg) for arg in args]))
else:
return command
barman-2.18/barman/output.py 0000644 0006212 0006212 00000206664 14172556763 014270 0 ustar 0000000 0000000 # -*- coding: utf-8 -*-
# © Copyright EnterpriseDB UK Limited 2013-2022
#
# This file is part of Barman.
#
# Barman is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Barman is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Barman. If not, see .
"""
This module control how the output of Barman will be rendered
"""
from __future__ import print_function
import datetime
import inspect
import json
import logging
import sys
from barman.infofile import BackupInfo
from barman.utils import (
BarmanEncoder,
force_str,
human_readable_timedelta,
pretty_size,
redact_passwords,
)
from barman.xlog import diff_lsn
__all__ = [
"error_occurred",
"debug",
"info",
"warning",
"error",
"exception",
"result",
"close_and_exit",
"close",
"set_output_writer",
"AVAILABLE_WRITERS",
"DEFAULT_WRITER",
"ConsoleOutputWriter",
"NagiosOutputWriter",
"JsonOutputWriter",
]
#: True if error or exception methods have been called
error_occurred = False
#: Exit code if error occurred
error_exit_code = 1
#: Enable colors in the output
ansi_colors_enabled = False
def _ansi_color(command):
"""
Return the ansi sequence for the provided color
"""
return "\033[%sm" % command
def _colored(message, color):
"""
Return a string formatted with the provided color.
"""
if ansi_colors_enabled:
return _ansi_color(color) + message + _ansi_color("0")
else:
return message
def _red(message):
"""
Format a red string
"""
return _colored(message, "31")
def _green(message):
"""
Format a green string
"""
return _colored(message, "32")
def _yellow(message):
"""
Format a yellow string
"""
return _colored(message, "33")
def _format_message(message, args):
"""
Format a message using the args list. The result will be equivalent to
message % args
If args list contains a dictionary as its only element the result will be
message % args[0]
:param str message: the template string to be formatted
:param tuple args: a list of arguments
:return: the formatted message
:rtype: str
"""
if len(args) == 1 and isinstance(args[0], dict):
return message % args[0]
elif len(args) > 0:
return message % args
else:
return message
def _put(level, message, *args, **kwargs):
"""
Send the message with all the remaining positional arguments to
the configured output manager with the right output level. The message will
be sent also to the logger unless explicitly disabled with log=False
No checks are performed on level parameter as this method is meant
to be called only by this module.
If level == 'exception' the stack trace will be also logged
:param str level:
:param str message: the template string to be formatted
:param tuple args: all remaining arguments are passed to the log formatter
:key bool log: whether to log the message
:key bool is_error: treat this message as an error
"""
# handle keyword-only parameters
log = kwargs.pop("log", True)
is_error = kwargs.pop("is_error", False)
global error_exit_code
error_exit_code = kwargs.pop("exit_code", error_exit_code)
if len(kwargs):
raise TypeError(
"%s() got an unexpected keyword argument %r"
% (inspect.stack()[1][3], kwargs.popitem()[0])
)
if is_error:
global error_occurred
error_occurred = True
_writer.error_occurred()
# Make sure the message is an unicode string
if message:
message = force_str(message)
# dispatch the call to the output handler
getattr(_writer, level)(message, *args)
# log the message as originating from caller's caller module
if log:
exc_info = False
if level == "exception":
level = "error"
exc_info = True
frm = inspect.stack()[2]
mod = inspect.getmodule(frm[0])
logger = logging.getLogger(mod.__name__)
log_level = logging.getLevelName(level.upper())
logger.log(log_level, message, *args, **{"exc_info": exc_info})
def _dispatch(obj, prefix, name, *args, **kwargs):
"""
Dispatch the call to the %(prefix)s_%(name) method of the obj object
:param obj: the target object
:param str prefix: prefix of the method to be called
:param str name: name of the method to be called
:param tuple args: all remaining positional arguments will be sent
to target
:param dict kwargs: all remaining keyword arguments will be sent to target
:return: the result of the invoked method
:raise ValueError: if the target method is not present
"""
method_name = "%s_%s" % (prefix, name)
handler = getattr(obj, method_name, None)
if callable(handler):
return handler(*args, **kwargs)
else:
raise ValueError(
"The object %r does not have the %r method" % (obj, method_name)
)
def is_quiet():
"""
Calls the "is_quiet" method, accessing the protected parameter _quiet
of the instanced OutputWriter
:return bool: the _quiet parameter value
"""
return _writer.is_quiet()
def is_debug():
"""
Calls the "is_debug" method, accessing the protected parameter _debug
of the instanced OutputWriter
:return bool: the _debug parameter value
"""
return _writer.is_debug()
def debug(message, *args, **kwargs):
"""
Output a message with severity 'DEBUG'
:key bool log: whether to log the message
"""
_put("debug", message, *args, **kwargs)
def info(message, *args, **kwargs):
"""
Output a message with severity 'INFO'
:key bool log: whether to log the message
"""
_put("info", message, *args, **kwargs)
def warning(message, *args, **kwargs):
"""
Output a message with severity 'INFO'
:key bool log: whether to log the message
"""
_put("warning", message, *args, **kwargs)
def error(message, *args, **kwargs):
"""
Output a message with severity 'ERROR'.
Also records that an error has occurred unless the ignore parameter
is True.
:key bool ignore: avoid setting an error exit status (default False)
:key bool log: whether to log the message
"""
# ignore is a keyword-only parameter
ignore = kwargs.pop("ignore", False)
if not ignore:
kwargs.setdefault("is_error", True)
_put("error", message, *args, **kwargs)
def exception(message, *args, **kwargs):
"""
Output a message with severity 'EXCEPTION'
If raise_exception parameter doesn't evaluate to false raise and exception:
- if raise_exception is callable raise the result of raise_exception()
- if raise_exception is an exception raise it
- else raise the last exception again
:key bool ignore: avoid setting an error exit status
:key raise_exception:
raise an exception after the message has been processed
:key bool log: whether to log the message
"""
# ignore and raise_exception are keyword-only parameters
ignore = kwargs.pop("ignore", False)
# noinspection PyNoneFunctionAssignment
raise_exception = kwargs.pop("raise_exception", None)
if not ignore:
kwargs.setdefault("is_error", True)
_put("exception", message, *args, **kwargs)
if raise_exception:
if callable(raise_exception):
# noinspection PyCallingNonCallable
raise raise_exception(message)
elif isinstance(raise_exception, BaseException):
raise raise_exception
else:
raise
def init(command, *args, **kwargs):
"""
Initialize the output writer for a given command.
:param str command: name of the command are being executed
:param tuple args: all remaining positional arguments will be sent
to the output processor
:param dict kwargs: all keyword arguments will be sent
to the output processor
"""
try:
_dispatch(_writer, "init", command, *args, **kwargs)
except ValueError:
exception(
'The %s writer does not support the "%s" command',
_writer.__class__.__name__,
command,
)
close_and_exit()
def result(command, *args, **kwargs):
"""
Output the result of an operation.
:param str command: name of the command are being executed
:param tuple args: all remaining positional arguments will be sent
to the output processor
:param dict kwargs: all keyword arguments will be sent
to the output processor
"""
try:
_dispatch(_writer, "result", command, *args, **kwargs)
except ValueError:
exception(
'The %s writer does not support the "%s" command',
_writer.__class__.__name__,
command,
)
close_and_exit()
def close_and_exit():
"""
Close the output writer and terminate the program.
If an error has been emitted the program will report a non zero return
value.
"""
close()
if error_occurred:
sys.exit(error_exit_code)
else:
sys.exit(0)
def close():
"""
Close the output writer.
"""
_writer.close()
def set_output_writer(new_writer, *args, **kwargs):
"""
Replace the current output writer with a new one.
The new_writer parameter can be a symbolic name or an OutputWriter object
:param new_writer: the OutputWriter name or the actual OutputWriter
:type: string or an OutputWriter
:param tuple args: all remaining positional arguments will be passed
to the OutputWriter constructor
:param dict kwargs: all remaining keyword arguments will be passed
to the OutputWriter constructor
"""
global _writer
_writer.close()
if new_writer in AVAILABLE_WRITERS:
_writer = AVAILABLE_WRITERS[new_writer](*args, **kwargs)
else:
_writer = new_writer
class ConsoleOutputWriter(object):
def __init__(self, debug=False, quiet=False):
"""
Default output writer that output everything on console.
:param bool debug: print debug messages on standard error
:param bool quiet: don't print info messages
"""
self._debug = debug
self._quiet = quiet
#: Used in check command to hold the check results
self.result_check_list = []
#: The minimal flag. If set the command must output a single list of
#: values.
self.minimal = False
#: The server is active
self.active = True
def _print(self, message, args, stream):
"""
Print an encoded message on the given output stream
"""
# Make sure to add a newline at the end of the message
if message is None:
message = "\n"
else:
message += "\n"
# Format and encode the message, redacting eventual passwords
encoded_msg = redact_passwords(_format_message(message, args)).encode("utf-8")
try:
# Python 3.x
stream.buffer.write(encoded_msg)
except AttributeError:
# Python 2.x
stream.write(encoded_msg)
stream.flush()
def _out(self, message, args):
"""
Print a message on standard output
"""
self._print(message, args, sys.stdout)
def _err(self, message, args):
"""
Print a message on standard error
"""
self._print(message, args, sys.stderr)
def is_quiet(self):
"""
Access the quiet property of the OutputWriter instance
:return bool: if the writer is quiet or not
"""
return self._quiet
def is_debug(self):
"""
Access the debug property of the OutputWriter instance
:return bool: if the writer is in debug mode or not
"""
return self._debug
def debug(self, message, *args):
"""
Emit debug.
"""
if self._debug:
self._err("DEBUG: %s" % message, args)
def info(self, message, *args):
"""
Normal messages are sent to standard output
"""
if not self._quiet:
self._out(message, args)
def warning(self, message, *args):
"""
Warning messages are sent to standard error
"""
self._err(_yellow("WARNING: %s" % message), args)
def error(self, message, *args):
"""
Error messages are sent to standard error
"""
self._err(_red("ERROR: %s" % message), args)
def exception(self, message, *args):
"""
Warning messages are sent to standard error
"""
self._err(_red("EXCEPTION: %s" % message), args)
def error_occurred(self):
"""
Called immediately before any message method when the originating
call has is_error=True
"""
def close(self):
"""
Close the output channel.
Nothing to do for console.
"""
def result_backup(self, backup_info):
"""
Render the result of a backup.
Nothing to do for console.
"""
# TODO: evaluate to display something useful here
def result_recovery(self, results):
"""
Render the result of a recovery.
"""
if len(results["changes"]) > 0:
self.info("")
self.info("IMPORTANT")
self.info("These settings have been modified to prevent data losses")
self.info("")
for assertion in results["changes"]:
self.info(
"%s line %s: %s = %s",
assertion.filename,
assertion.line,
assertion.key,
assertion.value,
)
if len(results["warnings"]) > 0:
self.info("")
self.info("WARNING")
self.info(
"You are required to review the following options"
" as potentially dangerous"
)
self.info("")
for assertion in results["warnings"]:
self.info(
"%s line %s: %s = %s",
assertion.filename,
assertion.line,
assertion.key,
assertion.value,
)
if results["missing_files"]:
# At least one file is missing, warn the user
self.info("")
self.info("WARNING")
self.info(
"The following configuration files have not been "
"saved during backup, hence they have not been "
"restored."
)
self.info(
"You need to manually restore them "
"in order to start the recovered PostgreSQL instance:"
)
self.info("")
for file_name in results["missing_files"]:
self.info(" %s" % file_name)
if results["delete_barman_wal"]:
self.info("")
self.info(
"After the recovery, please remember to remove the "
'"barman_wal" directory'
)
self.info("inside the PostgreSQL data directory.")
if results["get_wal"]:
self.info("")
self.info("WARNING: 'get-wal' is in the specified 'recovery_options'.")
self.info(
"Before you start up the PostgreSQL server, please "
"review the %s file",
results["recovery_configuration_file"],
)
self.info(
"inside the target directory. Make sure that "
"'restore_command' can be executed by "
"the PostgreSQL user."
)
self.info("")
self.info(
"Recovery completed (start time: %s, elapsed time: %s)",
results["recovery_start_time"],
human_readable_timedelta(
datetime.datetime.now() - results["recovery_start_time"]
),
)
self.info("")
self.info("Your PostgreSQL server has been successfully prepared for recovery!")
def _record_check(self, server_name, check, status, hint, perfdata):
"""
Record the check line in result_check_map attribute
This method is for subclass use
:param str server_name: the server is being checked
:param str check: the check name
:param bool status: True if succeeded
:param str,None hint: hint to print if not None
:param str,None perfdata: additional performance data to print if not None
"""
self.result_check_list.append(
dict(
server_name=server_name,
check=check,
status=status,
hint=hint,
perfdata=perfdata,
)
)
if not status and self.active:
global error_occurred
error_occurred = True
def init_check(self, server_name, active, disabled):
"""
Init the check command
:param str server_name: the server we are start listing
:param boolean active: The server is active
:param boolean disabled: The server is disabled
"""
display_name = server_name
# If the server has been manually disabled
if not active:
display_name += " (inactive)"
# If server has configuration errors
elif disabled:
display_name += " (WARNING: disabled)"
self.info("Server %s:" % display_name)
self.active = active
def result_check(self, server_name, check, status, hint=None, perfdata=None):
"""
Record a server result of a server check
and output it as INFO
:param str server_name: the server is being checked
:param str check: the check name
:param bool status: True if succeeded
:param str,None hint: hint to print if not None
:param str,None perfdata: additional performance data to print if not None
"""
self._record_check(server_name, check, status, hint, perfdata)
if hint:
self.info(
"\t%s: %s (%s)"
% (check, _green("OK") if status else _red("FAILED"), hint)
)
else:
self.info("\t%s: %s" % (check, _green("OK") if status else _red("FAILED")))
def init_list_backup(self, server_name, minimal=False):
"""
Init the list-backups command
:param str server_name: the server we are start listing
:param bool minimal: if true output only a list of backup id
"""
self.minimal = minimal
def result_list_backup(self, backup_info, backup_size, wal_size, retention_status):
"""
Output a single backup in the list-backups command
:param BackupInfo backup_info: backup we are displaying
:param backup_size: size of base backup (with the required WAL files)
:param wal_size: size of WAL files belonging to this backup
(without the required WAL files)
:param retention_status: retention policy status
"""
# If minimal is set only output the backup id
if self.minimal:
self.info(backup_info.backup_id)
return
out_list = ["%s %s - " % (backup_info.server_name, backup_info.backup_id)]
if backup_info.status in BackupInfo.STATUS_COPY_DONE:
end_time = backup_info.end_time.ctime()
out_list.append(
"%s - Size: %s - WAL Size: %s"
% (end_time, pretty_size(backup_size), pretty_size(wal_size))
)
if backup_info.tablespaces:
tablespaces = [
("%s:%s" % (tablespace.name, tablespace.location))
for tablespace in backup_info.tablespaces
]
out_list.append(" (tablespaces: %s)" % ", ".join(tablespaces))
if backup_info.status == BackupInfo.WAITING_FOR_WALS:
out_list.append(" - %s" % BackupInfo.WAITING_FOR_WALS)
if retention_status and retention_status != BackupInfo.NONE:
out_list.append(" - %s" % retention_status)
else:
out_list.append(backup_info.status)
self.info("".join(out_list))
def result_show_backup(self, backup_ext_info):
"""
Output all available information about a backup in show-backup command
The argument has to be the result
of a Server.get_backup_ext_info() call
:param dict backup_ext_info: a dictionary containing
the info to display
"""
data = dict(backup_ext_info)
self.info("Backup %s:", data["backup_id"])
self.info(" Server Name : %s", data["server_name"])
if data["systemid"]:
self.info(" System Id : %s", data["systemid"])
self.info(" Status : %s", data["status"])
if data["status"] in BackupInfo.STATUS_COPY_DONE:
self.info(" PostgreSQL Version : %s", data["version"])
self.info(" PGDATA directory : %s", data["pgdata"])
if data["tablespaces"]:
self.info(" Tablespaces:")
for item in data["tablespaces"]:
self.info(
" %s: %s (oid: %s)", item.name, item.location, item.oid
)
self.info("")
self.info(" Base backup information:")
self.info(
" Disk usage : %s (%s with WALs)",
pretty_size(data["size"]),
pretty_size(data["size"] + data["wal_size"]),
)
if data["deduplicated_size"] is not None and data["size"] > 0:
deduplication_ratio = 1 - (
float(data["deduplicated_size"]) / data["size"]
)
self.info(
" Incremental size : %s (-%s)",
pretty_size(data["deduplicated_size"]),
"{percent:.2%}".format(percent=deduplication_ratio),
)
self.info(" Timeline : %s", data["timeline"])
self.info(" Begin WAL : %s", data["begin_wal"])
self.info(" End WAL : %s", data["end_wal"])
self.info(" WAL number : %s", data["wal_num"])
# Output WAL compression ratio for basebackup WAL files
if data["wal_compression_ratio"] > 0:
self.info(
" WAL compression ratio: %s",
"{percent:.2%}".format(percent=data["wal_compression_ratio"]),
)
self.info(" Begin time : %s", data["begin_time"])
self.info(" End time : %s", data["end_time"])
# If copy statistics are available print a summary
copy_stats = data.get("copy_stats")
if copy_stats:
copy_time = copy_stats.get("copy_time")
if copy_time:
value = human_readable_timedelta(
datetime.timedelta(seconds=copy_time)
)
# Show analysis time if it is more than a second
analysis_time = copy_stats.get("analysis_time")
if analysis_time is not None and analysis_time >= 1:
value += " + %s startup" % (
human_readable_timedelta(
datetime.timedelta(seconds=analysis_time)
)
)
self.info(" Copy time : %s", value)
size = data["deduplicated_size"] or data["size"]
value = "%s/s" % pretty_size(size / copy_time)
number_of_workers = copy_stats.get("number_of_workers", 1)
if number_of_workers > 1:
value += " (%s jobs)" % number_of_workers
self.info(" Estimated throughput : %s", value)
self.info(" Begin Offset : %s", data["begin_offset"])
self.info(" End Offset : %s", data["end_offset"])
self.info(" Begin LSN : %s", data["begin_xlog"])
self.info(" End LSN : %s", data["end_xlog"])
self.info("")
self.info(" WAL information:")
self.info(" No of files : %s", data["wal_until_next_num"])
self.info(
" Disk usage : %s",
pretty_size(data["wal_until_next_size"]),
)
# Output WAL rate
if data["wals_per_second"] > 0:
self.info(
" WAL rate : %0.2f/hour",
data["wals_per_second"] * 3600,
)
# Output WAL compression ratio for archived WAL files
if data["wal_until_next_compression_ratio"] > 0:
self.info(
" Compression ratio : %s",
"{percent:.2%}".format(
percent=data["wal_until_next_compression_ratio"]
),
)
self.info(" Last available : %s", data["wal_last"])
if data["children_timelines"]:
timelines = data["children_timelines"]
self.info(
" Reachable timelines : %s",
", ".join([str(history.tli) for history in timelines]),
)
self.info("")
self.info(" Catalog information:")
self.info(
" Retention Policy : %s",
data["retention_policy_status"] or "not enforced",
)
previous_backup_id = data.setdefault("previous_backup_id", "not available")
self.info(
" Previous Backup : %s",
previous_backup_id or "- (this is the oldest base backup)",
)
next_backup_id = data.setdefault("next_backup_id", "not available")
self.info(
" Next Backup : %s",
next_backup_id or "- (this is the latest base backup)",
)
if data["children_timelines"]:
self.info("")
self.info(
"WARNING: WAL information is inaccurate due to "
"multiple timelines interacting with this backup"
)
else:
if data["error"]:
self.info(" Error: : %s", data["error"])
def init_status(self, server_name):
"""
Init the status command
:param str server_name: the server we are start listing
"""
self.info("Server %s:", server_name)
def result_status(self, server_name, status, description, message):
"""
Record a result line of a server status command
and output it as INFO
:param str server_name: the server is being checked
:param str status: the returned status code
:param str description: the returned status description
:param str,object message: status message. It will be converted to str
"""
self.info("\t%s: %s", description, str(message))
def init_replication_status(self, server_name, minimal=False):
"""
Init the 'standby-status' command
:param str server_name: the server we are start listing
:param str minimal: minimal output
"""
self.minimal = minimal
def result_replication_status(self, server_name, target, server_lsn, standby_info):
"""
Record a result line of a server status command
and output it as INFO
:param str server_name: the replication server
:param str target: all|hot-standby|wal-streamer
:param str server_lsn: server's current lsn
:param StatReplication standby_info: status info of a standby
"""
if target == "hot-standby":
title = "hot standby servers"
elif target == "wal-streamer":
title = "WAL streamers"
else:
title = "streaming clients"
if self.minimal:
# Minimal output
if server_lsn:
# current lsn from the master
self.info(
"%s for master '%s' (LSN @ %s):",
title.capitalize(),
server_name,
server_lsn,
)
else:
# We are connected to a standby
self.info("%s for slave '%s':", title.capitalize(), server_name)
else:
# Full output
self.info("Status of %s for server '%s':", title, server_name)
# current lsn from the master
if server_lsn:
self.info(" Current LSN on master: %s", server_lsn)
if standby_info is not None and not len(standby_info):
self.info(" No %s attached", title)
return
# Minimal output
if self.minimal:
n = 1
for standby in standby_info:
if not standby.replay_lsn:
# WAL streamer
self.info(
" %s. W) %s@%s S:%s W:%s P:%s AN:%s",
n,
standby.usename,
standby.client_addr or "socket",
standby.sent_lsn,
standby.write_lsn,
standby.sync_priority,
standby.application_name,
)
else:
# Standby
self.info(
" %s. %s) %s@%s S:%s F:%s R:%s P:%s AN:%s",
n,
standby.sync_state[0].upper(),
standby.usename,
standby.client_addr or "socket",
standby.sent_lsn,
standby.flush_lsn,
standby.replay_lsn,
standby.sync_priority,
standby.application_name,
)
n += 1
else:
n = 1
self.info(" Number of %s: %s", title, len(standby_info))
for standby in standby_info:
self.info("")
# Calculate differences in bytes
sent_diff = diff_lsn(standby.sent_lsn, standby.current_lsn)
write_diff = diff_lsn(standby.write_lsn, standby.current_lsn)
flush_diff = diff_lsn(standby.flush_lsn, standby.current_lsn)
replay_diff = diff_lsn(standby.replay_lsn, standby.current_lsn)
# Determine the sync stage of the client
sync_stage = None
if not standby.replay_lsn:
client_type = "WAL streamer"
max_level = 3
else:
client_type = "standby"
max_level = 5
# Only standby can replay WAL info
if replay_diff == 0:
sync_stage = "5/5 Hot standby (max)"
elif flush_diff == 0:
sync_stage = "4/5 2-safe" # remote flush
# If not yet done, set the sync stage
if not sync_stage:
if write_diff == 0:
sync_stage = "3/%s Remote write" % max_level
elif sent_diff == 0:
sync_stage = "2/%s WAL Sent (min)" % max_level
else:
sync_stage = "1/%s 1-safe" % max_level
# Synchronous standby
if getattr(standby, "sync_priority", None) > 0:
self.info(
" %s. #%s %s %s",
n,
standby.sync_priority,
standby.sync_state.capitalize(),
client_type,
)
# Asynchronous standby
else:
self.info(
" %s. %s %s", n, standby.sync_state.capitalize(), client_type
)
self.info(" Application name: %s", standby.application_name)
self.info(" Sync stage : %s", sync_stage)
if getattr(standby, "client_addr", None):
self.info(" Communication : TCP/IP")
self.info(
" IP Address : %s / Port: %s / Host: %s",
standby.client_addr,
standby.client_port,
standby.client_hostname or "-",
)
else:
self.info(" Communication : Unix domain socket")
self.info(" User name : %s", standby.usename)
self.info(
" Current state : %s (%s)", standby.state, standby.sync_state
)
if getattr(standby, "slot_name", None):
self.info(" Replication slot: %s", standby.slot_name)
self.info(" WAL sender PID : %s", standby.pid)
self.info(" Started at : %s", standby.backend_start)
if getattr(standby, "backend_xmin", None):
self.info(" Standby's xmin : %s", standby.backend_xmin or "-")
if getattr(standby, "sent_lsn", None):
self.info(
" Sent LSN : %s (diff: %s)",
standby.sent_lsn,
pretty_size(sent_diff),
)
if getattr(standby, "write_lsn", None):
self.info(
" Write LSN : %s (diff: %s)",
standby.write_lsn,
pretty_size(write_diff),
)
if getattr(standby, "flush_lsn", None):
self.info(
" Flush LSN : %s (diff: %s)",
standby.flush_lsn,
pretty_size(flush_diff),
)
if getattr(standby, "replay_lsn", None):
self.info(
" Replay LSN : %s (diff: %s)",
standby.replay_lsn,
pretty_size(replay_diff),
)
n += 1
def init_list_server(self, server_name, minimal=False):
"""
Init the list-servers command
:param str server_name: the server we are start listing
"""
self.minimal = minimal
def result_list_server(self, server_name, description=None):
"""
Output a result line of a list-servers command
:param str server_name: the server is being checked
:param str,None description: server description if applicable
"""
if self.minimal or not description:
self.info("%s", server_name)
else:
self.info("%s - %s", server_name, description)
def init_show_server(self, server_name):
"""
Init the show-servers command output method
:param str server_name: the server we are displaying
"""
self.info("Server %s:" % server_name)
def result_show_server(self, server_name, server_info):
"""
Output the results of the show-servers command
:param str server_name: the server we are displaying
:param dict server_info: a dictionary containing the info to display
"""
for status, message in sorted(server_info.items()):
self.info("\t%s: %s", status, message)
def init_check_wal_archive(self, server_name):
"""
Init the check-wal-archive command output method
:param str server_name: the server we are displaying
"""
self.info("Server %s:" % server_name)
def result_check_wal_archive(self, server_name):
"""
Output the results of the check-wal-archive command
:param str server_name: the server we are displaying
"""
self.info(" - WAL archive check for server %s passed" % server_name)
class JsonOutputWriter(ConsoleOutputWriter):
def __init__(self, *args, **kwargs):
"""
Output writer that writes on standard output using JSON.
When closed, it dumps all the collected results as a JSON object.
"""
super(JsonOutputWriter, self).__init__(*args, **kwargs)
#: Store JSON data
self.json_output = {}
def _mangle_key(self, value):
"""
Mangle a generic description to be used as dict key
:type value: str
:rtype: str
"""
return value.lower().replace(" ", "_").replace("-", "_").replace(".", "")
def _out_to_field(self, field, message, *args):
"""
Store a message in the required field
"""
if field not in self.json_output:
self.json_output[field] = []
message = _format_message(message, args)
self.json_output[field].append(message)
def debug(self, message, *args):
"""
Add debug messages in _DEBUG list
"""
if not self._debug:
return
self._out_to_field("_DEBUG", message, *args)
def info(self, message, *args):
"""
Add normal messages in _INFO list
"""
self._out_to_field("_INFO", message, *args)
def warning(self, message, *args):
"""
Add warning messages in _WARNING list
"""
self._out_to_field("_WARNING", message, *args)
def error(self, message, *args):
"""
Add error messages in _ERROR list
"""
self._out_to_field("_ERROR", message, *args)
def exception(self, message, *args):
"""
Add exception messages in _EXCEPTION list
"""
self._out_to_field("_EXCEPTION", message, *args)
def close(self):
"""
Close the output channel.
Print JSON output
"""
if not self._quiet:
json.dump(self.json_output, sys.stdout, sort_keys=True, cls=BarmanEncoder)
self.json_output = {}
def result_backup(self, backup_info):
"""
Save the result of a backup.
"""
self.json_output.update(backup_info.to_dict())
def result_recovery(self, results):
"""
Render the result of a recovery.
"""
changes_count = len(results["changes"])
self.json_output["changes_count"] = changes_count
self.json_output["changes"] = results["changes"]
if changes_count > 0:
self.warning(
"IMPORTANT! Some settings have been modified "
"to prevent data losses. See 'changes' key."
)
warnings_count = len(results["warnings"])
self.json_output["warnings_count"] = warnings_count
self.json_output["warnings"] = results["warnings"]
if warnings_count > 0:
self.warning(
"WARNING! You are required to review the options "
"as potentially dangerous. See 'warnings' key."
)
missing_files_count = len(results["missing_files"])
self.json_output["missing_files"] = results["missing_files"]
if missing_files_count > 0:
# At least one file is missing, warn the user
self.warning(
"WARNING! Some configuration files have not been "
"saved during backup, hence they have not been "
"restored. See 'missing_files' key."
)
if results["delete_barman_wal"]:
self.warning(
"After the recovery, please remember to remove the "
"'barman_wal' directory inside the PostgreSQL "
"data directory."
)
if results["get_wal"]:
self.warning(
"WARNING: 'get-wal' is in the specified "
"'recovery_options'. Before you start up the "
"PostgreSQL server, please review the recovery "
"configuration inside the target directory. "
"Make sure that 'restore_command' can be "
"executed by the PostgreSQL user."
)
self.json_output.update(
{
"recovery_start_time": results["recovery_start_time"].isoformat(" "),
"recovery_start_time_timestamp": results[
"recovery_start_time"
].strftime("%s"),
"recovery_elapsed_time": human_readable_timedelta(
datetime.datetime.now() - results["recovery_start_time"]
),
"recovery_elapsed_time_seconds": (
datetime.datetime.now() - results["recovery_start_time"]
).total_seconds(),
}
)
def init_check(self, server_name, active, disabled):
"""
Init the check command
:param str server_name: the server we are start listing
:param boolean active: The server is active
:param boolean disabled: The server is disabled
"""
self.json_output[server_name] = {}
self.active = active
def result_check(self, server_name, check, status, hint=None, perfdata=None):
"""
Record a server result of a server check
and output it as INFO
:param str server_name: the server is being checked
:param str check: the check name
:param bool status: True if succeeded
:param str,None hint: hint to print if not None
:param str,None perfdata: additional performance data to print if not None
"""
self._record_check(server_name, check, status, hint, perfdata)
check_key = self._mangle_key(check)
self.json_output[server_name][check_key] = dict(
status="OK" if status else "FAILED", hint=hint or ""
)
def init_list_backup(self, server_name, minimal=False):
"""
Init the list-backups command
:param str server_name: the server we are listing
:param bool minimal: if true output only a list of backup id
"""
self.minimal = minimal
self.json_output[server_name] = []
def result_list_backup(self, backup_info, backup_size, wal_size, retention_status):
"""
Output a single backup in the list-backups command
:param BackupInfo backup_info: backup we are displaying
:param backup_size: size of base backup (with the required WAL files)
:param wal_size: size of WAL files belonging to this backup
(without the required WAL files)
:param retention_status: retention policy status
"""
server_name = backup_info.server_name
# If minimal is set only output the backup id
if self.minimal:
self.json_output[server_name].append(backup_info.backup_id)
return
output = dict(
backup_id=backup_info.backup_id,
)
if backup_info.status in BackupInfo.STATUS_COPY_DONE:
output.update(
dict(
end_time_timestamp=backup_info.end_time.strftime("%s"),
end_time=backup_info.end_time.ctime(),
size_bytes=backup_size,
wal_size_bytes=wal_size,
size=pretty_size(backup_size),
wal_size=pretty_size(wal_size),
status=backup_info.status,
retention_status=retention_status or BackupInfo.NONE,
)
)
output["tablespaces"] = []
if backup_info.tablespaces:
for tablespace in backup_info.tablespaces:
output["tablespaces"].append(
dict(name=tablespace.name, location=tablespace.location)
)
else:
output.update(dict(status=backup_info.status))
self.json_output[server_name].append(output)
def result_show_backup(self, backup_ext_info):
"""
Output all available information about a backup in show-backup command
The argument has to be the result
of a Server.get_backup_ext_info() call
:param dict backup_ext_info: a dictionary containing
the info to display
"""
data = dict(backup_ext_info)
server_name = data["server_name"]
output = self.json_output[server_name] = dict(
backup_id=data["backup_id"], status=data["status"]
)
if data["status"] in BackupInfo.STATUS_COPY_DONE:
output.update(
dict(
postgresql_version=data["version"],
pgdata_directory=data["pgdata"],
tablespaces=[],
)
)
if data["tablespaces"]:
for item in data["tablespaces"]:
output["tablespaces"].append(
dict(name=item.name, location=item.location, oid=item.oid)
)
output["base_backup_information"] = dict(
disk_usage=pretty_size(data["size"]),
disk_usage_bytes=data["size"],
disk_usage_with_wals=pretty_size(data["size"] + data["wal_size"]),
disk_usage_with_wals_bytes=data["size"] + data["wal_size"],
)
if data["deduplicated_size"] is not None and data["size"] > 0:
deduplication_ratio = 1 - (
float(data["deduplicated_size"]) / data["size"]
)
output["base_backup_information"].update(
dict(
incremental_size=pretty_size(data["deduplicated_size"]),
incremental_size_bytes=data["deduplicated_size"],
incremental_size_ratio="-{percent:.2%}".format(
percent=deduplication_ratio
),
)
)
output["base_backup_information"].update(
dict(
timeline=data["timeline"],
begin_wal=data["begin_wal"],
end_wal=data["end_wal"],
)
)
if data["wal_compression_ratio"] > 0:
output["base_backup_information"].update(
dict(
wal_compression_ratio="{percent:.2%}".format(
percent=data["wal_compression_ratio"]
)
)
)
output["base_backup_information"].update(
dict(
begin_time_timestamp=data["begin_time"].strftime("%s"),
begin_time=data["begin_time"].isoformat(sep=" "),
end_time_timestamp=data["end_time"].strftime("%s"),
end_time=data["end_time"].isoformat(sep=" "),
)
)
copy_stats = data.get("copy_stats")
if copy_stats:
copy_time = copy_stats.get("copy_time")
analysis_time = copy_stats.get("analysis_time", 0)
if copy_time:
output["base_backup_information"].update(
dict(
copy_time=human_readable_timedelta(
datetime.timedelta(seconds=copy_time)
),
copy_time_seconds=copy_time,
analysis_time=human_readable_timedelta(
datetime.timedelta(seconds=analysis_time)
),
analysis_time_seconds=analysis_time,
)
)
size = data["deduplicated_size"] or data["size"]
output["base_backup_information"].update(
dict(
throughput="%s/s" % pretty_size(size / copy_time),
throughput_bytes=size / copy_time,
number_of_workers=copy_stats.get("number_of_workers", 1),
)
)
output["base_backup_information"].update(
dict(
begin_offset=data["begin_offset"],
end_offset=data["end_offset"],
begin_lsn=data["begin_xlog"],
end_lsn=data["end_xlog"],
)
)
wal_output = output["wal_information"] = dict(
no_of_files=data["wal_until_next_num"],
disk_usage=pretty_size(data["wal_until_next_size"]),
disk_usage_bytes=data["wal_until_next_size"],
wal_rate=0,
wal_rate_per_second=0,
compression_ratio=0,
last_available=data["wal_last"],
timelines=[],
)
# TODO: move the following calculations in a separate function
# or upstream (backup_ext_info?) so that they are shared with
# console output.
if data["wals_per_second"] > 0:
wal_output["wal_rate"] = "%0.2f/hour" % (data["wals_per_second"] * 3600)
wal_output["wal_rate_per_second"] = data["wals_per_second"]
if data["wal_until_next_compression_ratio"] > 0:
wal_output["compression_ratio"] = "{percent:.2%}".format(
percent=data["wal_until_next_compression_ratio"]
)
if data["children_timelines"]:
wal_output[
"_WARNING"
] = "WAL information is inaccurate \
due to multiple timelines interacting with \
this backup"
for history in data["children_timelines"]:
wal_output["timelines"].append(str(history.tli))
previous_backup_id = data.setdefault("previous_backup_id", "not available")
next_backup_id = data.setdefault("next_backup_id", "not available")
output["catalog_information"] = {
"retention_policy": data["retention_policy_status"] or "not enforced",
"previous_backup": previous_backup_id
or "- (this is the oldest base backup)",
"next_backup": next_backup_id or "- (this is the latest base backup)",
}
else:
if data["error"]:
output["error"] = data["error"]
def init_status(self, server_name):
"""
Init the status command
:param str server_name: the server we are start listing
"""
if not hasattr(self, "json_output"):
self.json_output = {}
self.json_output[server_name] = {}
def result_status(self, server_name, status, description, message):
"""
Record a result line of a server status command
and output it as INFO
:param str server_name: the server is being checked
:param str status: the returned status code
:param str description: the returned status description
:param str,object message: status message. It will be converted to str
"""
self.json_output[server_name][status] = dict(
description=description, message=str(message)
)
def init_replication_status(self, server_name, minimal=False):
"""
Init the 'standby-status' command
:param str server_name: the server we are start listing
:param str minimal: minimal output
"""
if not hasattr(self, "json_output"):
self.json_output = {}
self.json_output[server_name] = {}
self.minimal = minimal
def result_replication_status(self, server_name, target, server_lsn, standby_info):
"""
Record a result line of a server status command
and output it as INFO
:param str server_name: the replication server
:param str target: all|hot-standby|wal-streamer
:param str server_lsn: server's current lsn
:param StatReplication standby_info: status info of a standby
"""
if target == "hot-standby":
title = "hot standby servers"
elif target == "wal-streamer":
title = "WAL streamers"
else:
title = "streaming clients"
title_key = self._mangle_key(title)
if title_key not in self.json_output[server_name]:
self.json_output[server_name][title_key] = []
self.json_output[server_name]["server_lsn"] = server_lsn if server_lsn else None
if standby_info is not None and not len(standby_info):
self.json_output[server_name]["standby_info"] = "No %s attached" % title
return
self.json_output[server_name][title_key] = []
# Minimal output
if self.minimal:
for idx, standby in enumerate(standby_info):
if not standby.replay_lsn:
# WAL streamer
self.json_output[server_name][title_key].append(
dict(
user_name=standby.usename,
client_addr=standby.client_addr or "socket",
sent_lsn=standby.sent_lsn,
write_lsn=standby.write_lsn,
sync_priority=standby.sync_priority,
application_name=standby.application_name,
)
)
else:
# Standby
self.json_output[server_name][title_key].append(
dict(
sync_state=standby.sync_state[0].upper(),
user_name=standby.usename,
client_addr=standby.client_addr or "socket",
sent_lsn=standby.sent_lsn,
flush_lsn=standby.flush_lsn,
replay_lsn=standby.replay_lsn,
sync_priority=standby.sync_priority,
application_name=standby.application_name,
)
)
else:
for idx, standby in enumerate(standby_info):
self.json_output[server_name][title_key].append({})
json_output = self.json_output[server_name][title_key][idx]
# Calculate differences in bytes
lsn_diff = dict(
sent=diff_lsn(standby.sent_lsn, standby.current_lsn),
write=diff_lsn(standby.write_lsn, standby.current_lsn),
flush=diff_lsn(standby.flush_lsn, standby.current_lsn),
replay=diff_lsn(standby.replay_lsn, standby.current_lsn),
)
# Determine the sync stage of the client
sync_stage = None
if not standby.replay_lsn:
client_type = "WAL streamer"
max_level = 3
else:
client_type = "standby"
max_level = 5
# Only standby can replay WAL info
if lsn_diff["replay"] == 0:
sync_stage = "5/5 Hot standby (max)"
elif lsn_diff["flush"] == 0:
sync_stage = "4/5 2-safe" # remote flush
# If not yet done, set the sync stage
if not sync_stage:
if lsn_diff["write"] == 0:
sync_stage = "3/%s Remote write" % max_level
elif lsn_diff["sent"] == 0:
sync_stage = "2/%s WAL Sent (min)" % max_level
else:
sync_stage = "1/%s 1-safe" % max_level
# Synchronous standby
if getattr(standby, "sync_priority", None) > 0:
json_output["name"] = "#%s %s %s" % (
standby.sync_priority,
standby.sync_state.capitalize(),
client_type,
)
# Asynchronous standby
else:
json_output["name"] = "%s %s" % (
standby.sync_state.capitalize(),
client_type,
)
json_output["application_name"] = standby.application_name
json_output["sync_stage"] = sync_stage
if getattr(standby, "client_addr", None):
json_output.update(
dict(
communication="TCP/IP",
ip_address=standby.client_addr,
port=standby.client_port,
host=standby.client_hostname or None,
)
)
else:
json_output["communication"] = "Unix domain socket"
json_output.update(
dict(
user_name=standby.usename,
current_state=standby.state,
current_sync_state=standby.sync_state,
)
)
if getattr(standby, "slot_name", None):
json_output["replication_slot"] = standby.slot_name
json_output.update(
dict(
wal_sender_pid=standby.pid,
started_at=standby.backend_start.isoformat(sep=" "),
)
)
if getattr(standby, "backend_xmin", None):
json_output["standbys_xmin"] = standby.backend_xmin or None
for lsn in lsn_diff.keys():
standby_key = lsn + "_lsn"
if getattr(standby, standby_key, None):
json_output.update(
{
lsn + "_lsn": getattr(standby, standby_key),
lsn + "_lsn_diff": pretty_size(lsn_diff[lsn]),
lsn + "_lsn_diff_bytes": lsn_diff[lsn],
}
)
def init_list_server(self, server_name, minimal=False):
"""
Init the list-servers command
:param str server_name: the server we are listing
"""
self.json_output[server_name] = {}
self.minimal = minimal
def result_list_server(self, server_name, description=None):
"""
Output a result line of a list-servers command
:param str server_name: the server is being checked
:param str,None description: server description if applicable
"""
self.json_output[server_name] = dict(description=description)
def init_show_server(self, server_name):
"""
Init the show-servers command output method
:param str server_name: the server we are displaying
"""
self.json_output[server_name] = {}
def result_show_server(self, server_name, server_info):
"""
Output the results of the show-servers command
:param str server_name: the server we are displaying
:param dict server_info: a dictionary containing the info to display
"""
for status, message in sorted(server_info.items()):
if not isinstance(message, (int, str, bool, list, dict, type(None))):
message = str(message)
self.json_output[server_name][status] = message
def init_check_wal_archive(self, server_name):
"""
Init the check-wal-archive command output method
:param str server_name: the server we are displaying
"""
self.json_output[server_name] = {}
def result_check_wal_archive(self, server_name):
"""
Output the results of the check-wal-archive command
:param str server_name: the server we are displaying
"""
self.json_output[server_name] = (
"WAL archive check for server %s passed" % server_name
)
class NagiosOutputWriter(ConsoleOutputWriter):
"""
Nagios output writer.
This writer doesn't output anything to console.
On close it writes a nagios-plugin compatible status
"""
def _out(self, message, args):
"""
Do not print anything on standard output
"""
def _err(self, message, args):
"""
Do not print anything on standard error
"""
def _parse_check_results(self):
"""
Parse the check results and return the servers checked and any issues.
:return tuple: a tuple containing a list of checked servers, a list of all
issues found and a list of additional performance detail.
"""
# List of all servers that have been checked
servers = []
# List of servers reporting issues
issues = []
# Nagios performance data
perf_detail = []
for item in self.result_check_list:
# Keep track of all the checked servers
if item["server_name"] not in servers:
servers.append(item["server_name"])
# Keep track of the servers with issues
if not item["status"] and item["server_name"] not in issues:
issues.append(item["server_name"])
# Build the performance data list
if item["check"] == "backup minimum size":
perf_detail.append(
"%s=%dB" % (item["server_name"], int(item["perfdata"]))
)
if item["check"] == "wal size":
perf_detail.append(
"%s_wals=%dB" % (item["server_name"], int(item["perfdata"]))
)
return servers, issues, perf_detail
def _summarise_server_issues(self, issues):
"""
Converts the supplied list of issues into a printable summary.
:return tuple: A tuple where the first element is a string summarising each
server with issues and the second element is a string containing the
details of all failures for each server.
"""
fail_summary = []
details = []
for server in issues:
# Join all the issues for a server. Output format is in the
# form:
# " FAILED: , ... "
# All strings will be concatenated into the $SERVICEOUTPUT$
# macro of the Nagios output
server_fail = "%s FAILED: %s" % (
server,
", ".join(
[
item["check"]
for item in self.result_check_list
if item["server_name"] == server and not item["status"]
]
),
)
fail_summary.append(server_fail)
# Prepare an array with the detailed output for
# the $LONGSERVICEOUTPUT$ macro of the Nagios output
# line format:
# .: FAILED
# .: FAILED (Hint if present)
# : FAILED
# .....
for issue in self.result_check_list:
if issue["server_name"] == server and not issue["status"]:
fail_detail = "%s.%s: FAILED" % (server, issue["check"])
if issue["hint"]:
fail_detail += " (%s)" % issue["hint"]
details.append(fail_detail)
return fail_summary, details
def _print_check_failure(self, servers, issues, perf_detail):
"""Prints the output for a failed check."""
# Generate the performance data message - blank string if no perf detail
perf_detail_message = perf_detail and "|%s" % " ".join(perf_detail) or ""
fail_summary, details = self._summarise_server_issues(issues)
# Append the summary of failures to the first line of the output
# using * as delimiter
if len(servers) == 1:
print(
"BARMAN CRITICAL - server %s has issues * %s%s"
% (servers[0], " * ".join(fail_summary), perf_detail_message)
)
else:
print(
"BARMAN CRITICAL - %d server out of %d have issues * "
"%s%s"
% (
len(issues),
len(servers),
" * ".join(fail_summary),
perf_detail_message,
)
)
# add the detailed list to the output
for issue in details:
print(issue)
def _print_check_success(self, servers, issues=None, perf_detail=None):
"""Prints the output for a successful check."""
if issues is None:
issues = []
# Generate the issues message - blank string if no issues
issues_message = "".join([" * IGNORING: %s" % issue for issue in issues])
# Generate the performance data message - blank string if no perf detail
perf_detail_message = perf_detail and "|%s" % " ".join(perf_detail) or ""
# Some issues, but only in skipped server
good = [item for item in servers if item not in issues]
# Display the output message for a single server check
if len(good) == 0:
print("BARMAN OK - No server configured%s" % issues_message)
elif len(good) == 1:
print(
"BARMAN OK - Ready to serve the Espresso backup "
"for %s%s%s" % (good[0], issues_message, perf_detail_message)
)
else:
# Display the output message for several servers, using
# '*' as delimiter
print(
"BARMAN OK - Ready to serve the Espresso backup "
"for %d servers * %s%s%s"
% (len(good), " * ".join(good), issues_message, perf_detail_message)
)
def close(self):
"""
Display the result of a check run as expected by Nagios.
Also set the exit code as 2 (CRITICAL) in case of errors
"""
global error_occurred, error_exit_code
servers, issues, perf_detail = self._parse_check_results()
# Global error (detected at configuration level)
if len(issues) == 0 and error_occurred:
print("BARMAN CRITICAL - Global configuration errors")
error_exit_code = 2
return
if len(issues) > 0 and error_occurred:
self._print_check_failure(servers, issues, perf_detail)
error_exit_code = 2
else:
self._print_check_success(servers, issues, perf_detail)
#: This dictionary acts as a registry of available OutputWriters
AVAILABLE_WRITERS = {
"console": ConsoleOutputWriter,
"json": JsonOutputWriter,
# nagios is not registered as it isn't a general purpose output writer
# 'nagios': NagiosOutputWriter,
}
#: The default OutputWriter
DEFAULT_WRITER = "console"
#: the current active writer. Initialized according DEFAULT_WRITER on load
_writer = AVAILABLE_WRITERS[DEFAULT_WRITER]()
barman-2.18/barman/clients/ 0000755 0006212 0006212 00000000000 14172556766 014004 5 ustar 0000000 0000000 barman-2.18/barman/clients/cloud_backup.py 0000755 0006212 0006212 00000023062 14172556763 017014 0 ustar 0000000 0000000 # -*- coding: utf-8 -*-
# © Copyright EnterpriseDB UK Limited 2018-2022
#
# This file is part of Barman.
#
# Barman is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Barman is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Barman. If not, see .
import logging
import os
import re
import tempfile
from contextlib import closing
from shutil import rmtree
from barman.clients.cloud_cli import (
add_tag_argument,
create_argument_parser,
GeneralErrorExit,
NetworkErrorExit,
OperationErrorExit,
UrlArgumentType,
)
from barman.cloud import (
CloudBackupUploaderBarman,
CloudBackupUploaderPostgres,
configure_logging,
)
from barman.cloud_providers import get_cloud_interface
from barman.exceptions import (
BarmanException,
PostgresConnectionError,
UnrecoverableHookScriptError,
)
from barman.postgres import PostgreSQLConnection
from barman.utils import check_positive, check_size, force_str
_find_space = re.compile(r"[\s]").search
def __is_hook_script():
"""Check the environment and determine if we are running as a hook script"""
if "BARMAN_HOOK" in os.environ and "BARMAN_PHASE" in os.environ:
if (
os.getenv("BARMAN_HOOK") in ("backup_script", "backup_retry_script")
and os.getenv("BARMAN_PHASE") == "post"
):
return True
else:
raise BarmanException(
"barman-cloud-backup called as unsupported hook script: %s_%s"
% (os.getenv("BARMAN_PHASE"), os.getenv("BARMAN_HOOK"))
)
else:
return False
def quote_conninfo(value):
"""
Quote a connection info parameter
:param str value:
:rtype: str
"""
if not value:
return "''"
if not _find_space(value):
return value
return "'%s'" % value.replace("\\", "\\\\").replace("'", "\\'")
def build_conninfo(config):
"""
Build a DSN to connect to postgres using command-line arguments
"""
conn_parts = []
# If -d specified a conninfo string, just return it
if config.dbname is not None:
if config.dbname == "" or "=" in config.dbname:
return config.dbname
if config.host:
conn_parts.append("host=%s" % quote_conninfo(config.host))
if config.port:
conn_parts.append("port=%s" % quote_conninfo(config.port))
if config.user:
conn_parts.append("user=%s" % quote_conninfo(config.user))
if config.dbname:
conn_parts.append("dbname=%s" % quote_conninfo(config.dbname))
return " ".join(conn_parts)
def main(args=None):
"""
The main script entry point
:param list[str] args: the raw arguments list. When not provided
it defaults to sys.args[1:]
"""
config = parse_arguments(args)
configure_logging(config)
tempdir = tempfile.mkdtemp(prefix="barman-cloud-backup-")
try:
# Create any temporary file in the `tempdir` subdirectory
tempfile.tempdir = tempdir
cloud_interface = get_cloud_interface(config)
if not cloud_interface.test_connectivity():
raise NetworkErrorExit()
# If test is requested, just exit after connectivity test
elif config.test:
raise SystemExit(0)
with closing(cloud_interface):
# TODO: Should the setup be optional?
cloud_interface.setup_bucket()
# Perform the backup
uploader_kwargs = {
"server_name": config.server_name,
"compression": config.compression,
"max_archive_size": config.max_archive_size,
"cloud_interface": cloud_interface,
}
if __is_hook_script():
if "BARMAN_BACKUP_DIR" not in os.environ:
raise BarmanException(
"BARMAN_BACKUP_DIR environment variable not set"
)
if "BARMAN_BACKUP_ID" not in os.environ:
raise BarmanException(
"BARMAN_BACKUP_ID environment variable not set"
)
if os.getenv("BARMAN_STATUS") != "DONE":
raise UnrecoverableHookScriptError(
"backup in '%s' has status '%s' (status should be: DONE)"
% (os.getenv("BARMAN_BACKUP_DIR"), os.getenv("BARMAN_STATUS"))
)
uploader = CloudBackupUploaderBarman(
backup_dir=os.getenv("BARMAN_BACKUP_DIR"),
backup_id=os.getenv("BARMAN_BACKUP_ID"),
**uploader_kwargs
)
uploader.backup()
else:
conninfo = build_conninfo(config)
postgres = PostgreSQLConnection(
conninfo,
config.immediate_checkpoint,
application_name="barman_cloud_backup",
)
try:
postgres.connect()
except PostgresConnectionError as exc:
logging.error("Cannot connect to postgres: %s", force_str(exc))
logging.debug("Exception details:", exc_info=exc)
raise OperationErrorExit()
with closing(postgres):
uploader = CloudBackupUploaderPostgres(
postgres=postgres, **uploader_kwargs
)
uploader.backup()
except KeyboardInterrupt as exc:
logging.error("Barman cloud backup was interrupted by the user")
logging.debug("Exception details:", exc_info=exc)
raise OperationErrorExit()
except UnrecoverableHookScriptError as exc:
logging.error("Barman cloud backup exception: %s", force_str(exc))
logging.debug("Exception details:", exc_info=exc)
raise SystemExit(63)
except Exception as exc:
logging.error("Barman cloud backup exception: %s", force_str(exc))
logging.debug("Exception details:", exc_info=exc)
raise GeneralErrorExit()
finally:
# Remove the temporary directory and all the contained files
rmtree(tempdir, ignore_errors=True)
def parse_arguments(args=None):
"""
Parse command line arguments
:return: The options parsed
"""
parser, s3_arguments, azure_arguments = create_argument_parser(
description="This script can be used to perform a backup "
"of a local PostgreSQL instance and ship "
"the resulting tarball(s) to the Cloud. "
"Currently AWS S3 and Azure Blob Storage are supported.",
source_or_destination=UrlArgumentType.destination,
)
compression = parser.add_mutually_exclusive_group()
compression.add_argument(
"-z",
"--gzip",
help="gzip-compress the WAL while uploading to the cloud",
action="store_const",
const="gz",
dest="compression",
)
compression.add_argument(
"-j",
"--bzip2",
help="bzip2-compress the WAL while uploading to the cloud",
action="store_const",
const="bz2",
dest="compression",
)
compression.add_argument(
"--snappy",
help="snappy-compress the WAL while uploading to the cloud ",
action="store_const",
const="snappy",
dest="compression",
)
parser.add_argument(
"-h",
"--host",
help="host or Unix socket for PostgreSQL connection "
"(default: libpq settings)",
)
parser.add_argument(
"-p",
"--port",
help="port for PostgreSQL connection (default: libpq settings)",
)
parser.add_argument(
"-U",
"--user",
help="user name for PostgreSQL connection (default: libpq settings)",
)
parser.add_argument(
"--immediate-checkpoint",
help="forces the initial checkpoint to be done as quickly as possible",
action="store_true",
)
parser.add_argument(
"-J",
"--jobs",
type=check_positive,
help="number of subprocesses to upload data to cloud storage (default: 2)",
default=2,
)
parser.add_argument(
"-S",
"--max-archive-size",
type=check_size,
help="maximum size of an archive when uploading to cloud storage "
"(default: 100GB)",
default="100GB",
)
parser.add_argument(
"-d",
"--dbname",
help="Database name or conninfo string for Postgres connection (default: postgres)",
default="postgres",
)
add_tag_argument(
parser,
name="tags",
help="Tags to be added to all uploaded files in cloud storage",
)
s3_arguments.add_argument(
"-e",
"--encryption",
help="The encryption algorithm used when storing the uploaded data in S3. "
"Allowed values: 'AES256'|'aws:kms'.",
choices=["AES256", "aws:kms"],
)
azure_arguments.add_argument(
"--encryption-scope",
help="The name of an encryption scope defined in the Azure Blob Storage "
"service which is to be used to encrypt the data in Azure",
)
return parser.parse_args(args=args)
if __name__ == "__main__":
main()
barman-2.18/barman/clients/__init__.py 0000644 0006212 0006212 00000001324 14172556763 016112 0 ustar 0000000 0000000 # -*- coding: utf-8 -*-
# © Copyright EnterpriseDB UK Limited 2019-2022
#
# This file is part of Barman.
#
# Barman is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Barman is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Barman. If not, see .
barman-2.18/barman/clients/cloud_backup_keep.py 0000644 0006212 0006212 00000010303 14172556763 020007 0 ustar 0000000 0000000 # -*- coding: utf-8 -*-
# © Copyright EnterpriseDB UK Limited 2018-2022
#
# This file is part of Barman.
#
# Barman is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Barman is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Barman. If not, see .
import logging
from contextlib import closing
from barman.annotations import KeepManager
from barman.clients.cloud_cli import (
create_argument_parser,
GeneralErrorExit,
NetworkErrorExit,
OperationErrorExit,
)
from barman.cloud import CloudBackupCatalog, configure_logging
from barman.cloud_providers import get_cloud_interface
from barman.infofile import BackupInfo
from barman.utils import force_str
def main(args=None):
"""
The main script entry point
:param list[str] args: the raw arguments list. When not provided
it defaults to sys.args[1:]
"""
config = parse_arguments(args)
configure_logging(config)
try:
cloud_interface = get_cloud_interface(config)
with closing(cloud_interface):
if not cloud_interface.test_connectivity():
raise NetworkErrorExit()
# If test is requested, just exit after connectivity test
elif config.test:
raise SystemExit(0)
if not cloud_interface.bucket_exists:
logging.error("Bucket %s does not exist", cloud_interface.bucket_name)
raise OperationErrorExit()
catalog = CloudBackupCatalog(cloud_interface, config.server_name)
if config.release:
catalog.release_keep(config.backup_id)
elif config.status:
target = catalog.get_keep_target(config.backup_id)
if target:
print("Keep: %s" % target)
else:
print("Keep: nokeep")
else:
backup_info = catalog.get_backup_info(config.backup_id)
if backup_info.status == BackupInfo.DONE:
catalog.keep_backup(config.backup_id, config.target)
else:
logging.error(
"Cannot add keep to backup %s because it has status %s. "
"Only backups with status DONE can be kept.",
config.backup_id,
backup_info.status,
)
raise OperationErrorExit()
except Exception as exc:
logging.error("Barman cloud keep exception: %s", force_str(exc))
logging.debug("Exception details:", exc_info=exc)
raise GeneralErrorExit()
def parse_arguments(args=None):
"""
Parse command line arguments
:return: The options parsed
"""
parser, _, _ = create_argument_parser(
description="This script can be used to tag backups in cloud storage as "
"archival backups such that they will not be deleted. "
"Currently AWS S3 and Azure Blob Storage are supported.",
)
parser.add_argument(
"backup_id",
help="the backup ID of the backup to be kept",
)
keep_options = parser.add_mutually_exclusive_group(required=True)
keep_options.add_argument(
"-r",
"--release",
help="If specified, the command will remove the keep annotation and the "
"backup will be eligible for deletion",
action="store_true",
)
keep_options.add_argument(
"-s",
"--status",
help="Print the keep status of the backup",
action="store_true",
)
keep_options.add_argument(
"--target",
help="Specify the recovery target for this backup",
choices=[KeepManager.TARGET_FULL, KeepManager.TARGET_STANDALONE],
)
return parser.parse_args(args=args)
if __name__ == "__main__":
main()
barman-2.18/barman/clients/cloud_cli.py 0000644 0006212 0006212 00000013423 14172556763 016313 0 ustar 0000000 0000000 # -*- coding: utf-8 -*-
# © Copyright EnterpriseDB UK Limited 2018-2022
#
# This file is part of Barman.
#
# Barman is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Barman is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Barman. If not, see .
import argparse
import csv
import logging
from enum import Enum
import barman
from barman.utils import force_str
class OperationErrorExit(SystemExit):
"""
Dedicated exit code for errors where connectivity to the cloud provider was ok
but the operation still failed.
"""
def __init__(self):
super(OperationErrorExit, self).__init__(1)
class NetworkErrorExit(SystemExit):
"""Dedicated exit code for network related errors."""
def __init__(self):
super(NetworkErrorExit, self).__init__(2)
class CLIErrorExit(SystemExit):
"""Dedicated exit code for CLI level errors."""
def __init__(self):
super(CLIErrorExit, self).__init__(3)
class GeneralErrorExit(SystemExit):
"""Dedicated exit code for general barman cloud errors."""
def __init__(self):
super(GeneralErrorExit, self).__init__(4)
class UrlArgumentType(Enum):
source = "source"
destination = "destination"
def __parse_tag(tag):
"""Parse key,value tag with csv reader"""
try:
rows = list(csv.reader([tag], delimiter=","))
except csv.Error as exc:
logging.error(
"Error parsing tag %s: %s",
tag,
force_str(exc),
)
raise CLIErrorExit()
if len(rows) != 1 or len(rows[0]) != 2:
logging.error(
"Invalid tag format: %s",
tag,
)
raise CLIErrorExit()
return tuple(rows[0])
def add_tag_argument(parser, name, help):
parser.add_argument(
"--%s" % name,
type=__parse_tag,
nargs="*",
help=help,
)
class CloudArgumentParser(argparse.ArgumentParser):
"""ArgumentParser which exits with CLIErrorExit on errors."""
def error(self, message):
try:
super(CloudArgumentParser, self).error(message)
except SystemExit:
raise CLIErrorExit()
def create_argument_parser(description, source_or_destination=UrlArgumentType.source):
"""
Create a barman-cloud argument parser with the given description.
Returns an `argparse.ArgumentParser` object which parses the core arguments
and options for barman-cloud commands.
"""
parser = CloudArgumentParser(
description=description,
add_help=False,
)
parser.add_argument(
"%s_url" % source_or_destination.value,
help=(
"URL of the cloud %s, such as a bucket in AWS S3."
" For example: `s3://bucket/path/to/folder`."
)
% source_or_destination.value,
)
parser.add_argument(
"server_name", help="the name of the server as configured in Barman."
)
parser.add_argument(
"-V", "--version", action="version", version="%%(prog)s %s" % barman.__version__
)
parser.add_argument("--help", action="help", help="show this help message and exit")
verbosity = parser.add_mutually_exclusive_group()
verbosity.add_argument(
"-v",
"--verbose",
action="count",
default=0,
help="increase output verbosity (e.g., -vv is more than -v)",
)
verbosity.add_argument(
"-q",
"--quiet",
action="count",
default=0,
help="decrease output verbosity (e.g., -qq is less than -q)",
)
parser.add_argument(
"-t",
"--test",
help="Test cloud connectivity and exit",
action="store_true",
default=False,
)
parser.add_argument(
"--cloud-provider",
help="The cloud provider to use as a storage backend",
choices=["aws-s3", "azure-blob-storage"],
default="aws-s3",
)
s3_arguments = parser.add_argument_group(
"Extra options for the aws-s3 cloud provider"
)
s3_arguments.add_argument(
"--endpoint-url",
help="Override default S3 endpoint URL with the given one",
)
s3_arguments.add_argument(
"-P",
"--profile",
help="profile name (e.g. INI section in AWS credentials file)",
)
azure_arguments = parser.add_argument_group(
"Extra options for the azure-blob-storage cloud provider"
)
azure_arguments.add_argument(
"--credential",
choices=["azure-cli", "managed-identity"],
help="Optionally specify the type of credential to use when "
"authenticating with Azure Blob Storage. If omitted then "
"the credential will be obtained from the environment. If no "
"credentials can be found in the environment then the default "
"Azure authentication flow will be used",
)
return parser, s3_arguments, azure_arguments
azure = [
(
"--credential",
{
"choices": ["azure-cli", "managed-identity"],
"help": (
"Optionally specify the type of credential to use when "
"authenticating with Azure Blob Storage. If omitted then "
"the credential will be obtained from the environment. If no "
"credentials can be found in the environment then the default "
"Azure authentication flow will be used"
),
},
),
]
barman-2.18/barman/clients/cloud_compression.py 0000644 0006212 0006212 00000014236 14172556763 020110 0 ustar 0000000 0000000 # -*- coding: utf-8 -*-
# © Copyright EnterpriseDB UK Limited 2018-2022
#
# This file is part of Barman.
#
# Barman is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Barman is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Barman. If not, see .
import bz2
import gzip
import shutil
from abc import ABCMeta, abstractmethod
from io import BytesIO
from barman.utils import with_metaclass
def _try_import_snappy():
try:
import snappy
except ImportError:
raise SystemExit("Missing required python module: python-snappy")
return snappy
class ChunkedCompressor(with_metaclass(ABCMeta, object)):
"""
Base class for all ChunkedCompressors
"""
@abstractmethod
def add_chunk(self, data):
"""
Compresses the supplied data and returns all the compressed bytes.
:param bytes data: The chunk of data to be compressed
:return: The compressed data
:rtype: bytes
"""
@abstractmethod
def decompress(self, data):
"""
Decompresses the supplied chunk of data and returns at least part of the
uncompressed data.
:param bytes data: The chunk of data to be decompressed
:return: The decompressed data
:rtype: bytes
"""
class SnappyCompressor(ChunkedCompressor):
"""
A ChunkedCompressor implementation based on python-snappy
"""
def __init__(self):
snappy = _try_import_snappy()
self.compressor = snappy.StreamCompressor()
self.decompressor = snappy.StreamDecompressor()
def add_chunk(self, data):
"""
Compresses the supplied data and returns all the compressed bytes.
:param bytes data: The chunk of data to be compressed
:return: The compressed data
:rtype: bytes
"""
return self.compressor.add_chunk(data)
def decompress(self, data):
"""
Decompresses the supplied chunk of data and returns at least part of the
uncompressed data.
:param bytes data: The chunk of data to be decompressed
:return: The decompressed data
:rtype: bytes
"""
return self.decompressor.decompress(data)
def get_compressor(compression):
"""
Helper function which returns a ChunkedCompressor for the specified compression
algorithm. Currently only snappy is supported. The other compression algorithms
supported by barman cloud use the decompression built into TarFile.
:param str compression: The compression algorithm to use. Can be set to snappy
or any compression supported by the TarFile mode string.
:return: A ChunkedCompressor capable of compressing and decompressing using the
specified compression.
:rtype: ChunkedCompressor
"""
if compression == "snappy":
return SnappyCompressor()
return None
def compress(wal_file, compression):
"""
Compresses the supplied wal_file and returns a file-like object containing the
compressed data.
:param IOBase wal_file: A file-like object containing the WAL file data.
:param str compression: The compression algorithm to apply. Can be one of:
bzip2, gzip, snappy.
:return: The compressed data
:rtype: BytesIO
"""
if compression == "snappy":
in_mem_snappy = BytesIO()
snappy = _try_import_snappy()
snappy.stream_compress(wal_file, in_mem_snappy)
in_mem_snappy.seek(0)
return in_mem_snappy
elif compression == "gzip":
# Create a BytesIO for in memory compression
in_mem_gzip = BytesIO()
with gzip.GzipFile(fileobj=in_mem_gzip, mode="wb") as gz:
# copy the gzipped data in memory
shutil.copyfileobj(wal_file, gz)
in_mem_gzip.seek(0)
return in_mem_gzip
elif compression == "bzip2":
# Create a BytesIO for in memory compression
in_mem_bz2 = BytesIO(bz2.compress(wal_file.read()))
in_mem_bz2.seek(0)
return in_mem_bz2
else:
raise ValueError("Unknown compression type: %s" % compression)
def get_streaming_tar_mode(mode, compression):
"""
Helper function used in streaming uploads and downloads which appends the supplied
compression to the raw filemode (either r or w) and returns the result. Any
compression algorithms supported by barman-cloud but not Python TarFile are
ignored so that barman-cloud can apply them itself.
:param str mode: The file mode to use, either r or w.
:param str compression: The compression algorithm to use. Can be set to snappy
or any compression supported by the TarFile mode string.
:return: The full filemode for a streaming tar file
:rtype: str
"""
if compression == "snappy" or compression is None:
return "%s|" % mode
else:
return "%s|%s" % (mode, compression)
def decompress_to_file(blob, dest_file, compression):
"""
Decompresses the supplied blob of data into the dest_file file-like object using
the specified compression.
:param IOBase blob: A file-like object containing the compressed data.
:param IOBase dest_file: A file-like object into which the uncompressed data
should be written.
:param str compression: The compression algorithm to apply. Can be one of:
bzip2, gzip, snappy.
:rtype: None
"""
if compression == "snappy":
snappy = _try_import_snappy()
snappy.stream_decompress(blob, dest_file)
return
elif compression == "gzip":
source_file = gzip.GzipFile(fileobj=blob, mode="rb")
elif compression == "bzip2":
source_file = bz2.BZ2File(blob, "rb")
else:
raise ValueError("Unknown compression type: %s" % compression)
with source_file:
shutil.copyfileobj(source_file, dest_file)
barman-2.18/barman/clients/walrestore.py 0000755 0006212 0006212 00000037373 14172556763 016562 0 ustar 0000000 0000000 # -*- coding: utf-8 -*-
# walrestore - Remote Barman WAL restore command for PostgreSQL
#
# This script remotely fetches WAL files from Barman via SSH, on demand.
# It is intended to be used in restore_command in recovery configuration files
# of PostgreSQL standby servers. Supports parallel fetching and
# protects against SSH failures.
#
# See the help page for usage information.
#
# © Copyright EnterpriseDB UK Limited 2016-2022
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see .
from __future__ import print_function
import argparse
import os
import shutil
import subprocess
import sys
import time
import barman
from barman.utils import force_str
DEFAULT_USER = "barman"
DEFAULT_SPOOL_DIR = "/var/tmp/walrestore"
# The string_types list is used to identify strings
# in a consistent way between python 2 and 3
if sys.version_info[0] == 3:
string_types = (str,)
else:
string_types = (basestring,) # noqa
def main(args=None):
"""
The main script entry point
"""
config = parse_arguments(args)
# Do connectivity test if requested
if config.test:
connectivity_test(config)
return # never reached
# Check WAL destination is not a directory
if os.path.isdir(config.wal_dest):
exit_with_error(
"WAL_DEST cannot be a directory: %s" % config.wal_dest, status=3
)
# Open the destination file
try:
dest_file = open(config.wal_dest, "wb")
except EnvironmentError as e:
exit_with_error(
"Cannot open '%s' (WAL_DEST) for writing: %s" % (config.wal_dest, e),
status=3,
)
return # never reached
# If the file is present in SPOOL_DIR use it and terminate
try_deliver_from_spool(config, dest_file)
# If required load the list of files to download in parallel
additional_files = peek_additional_files(config)
try:
# Execute barman get-wal through the ssh connection
ssh_process = RemoteGetWal(config, config.wal_name, dest_file)
except EnvironmentError as e:
exit_with_error('Error executing "ssh": %s' % e, sleep=config.sleep)
return # never reached
# Spawn a process for every additional file
parallel_ssh_processes = spawn_additional_process(config, additional_files)
# Wait for termination of every subprocess. If CTRL+C is pressed,
# terminate all of them
try:
RemoteGetWal.wait_for_all()
finally:
# Cleanup failed spool files in case of errors
for process in parallel_ssh_processes:
if process.returncode != 0:
os.unlink(process.dest_file)
# If the command succeeded exit here
if ssh_process.returncode == 0:
sys.exit(0)
# Report the exit code, remapping ssh failure code (255) to 2
if ssh_process.returncode == 255:
exit_with_error("Connection problem with ssh", 2, sleep=config.sleep)
else:
exit_with_error(
"Remote 'barman get-wal' command has failed!",
ssh_process.returncode,
sleep=config.sleep,
)
def spawn_additional_process(config, additional_files):
"""
Execute additional barman get-wal processes
:param argparse.Namespace config: the configuration from command line
:param additional_files: A list of WAL file to be downloaded in parallel
:return list[subprocess.Popen]: list of created processes
"""
processes = []
for wal_name in additional_files:
spool_file_name = os.path.join(config.spool_dir, wal_name)
try:
# Spawn a process and write the output in the spool dir
process = RemoteGetWal(config, wal_name, spool_file_name)
processes.append(process)
except EnvironmentError:
# If execution has failed make sure the spool file is unlinked
try:
os.unlink(spool_file_name)
except EnvironmentError:
# Suppress unlink errors
pass
return processes
def peek_additional_files(config):
"""
Invoke remote get-wal --peek to receive a list of wal files to copy
:param argparse.Namespace config: the configuration from command line
:returns set: a set of WAL file names from the peek command
"""
# If parallel downloading is not required return an empty array
if not config.parallel:
return []
# Make sure the SPOOL_DIR exists
try:
if not os.path.exists(config.spool_dir):
os.mkdir(config.spool_dir)
except EnvironmentError as e:
exit_with_error("Cannot create '%s' directory: %s" % (config.spool_dir, e))
# Retrieve the list of files from remote
additional_files = execute_peek(config)
# Sanity check
if len(additional_files) == 0 or additional_files[0] != config.wal_name:
exit_with_error("The required file is not available: %s" % config.wal_name)
# Remove the first element, as now we know is identical to config.wal_name
del additional_files[0]
return additional_files
def build_ssh_command(config, wal_name, peek=0):
"""
Prepare an ssh command according to the arguments passed on command line
:param argparse.Namespace config: the configuration from command line
:param str wal_name: the wal_name get-wal parameter
:param int peek: in
:return list[str]: the ssh command as list of string
"""
ssh_command = [
"ssh",
"-q", # quiet mode - suppress warnings
"-T", # disable pseudo-terminal allocation
"%s@%s" % (config.user, config.barman_host),
"barman",
]
if config.config:
ssh_command.append("--config %s" % config.config)
options = []
if config.test:
options.append("--test")
if peek:
options.append("--peek '%s'" % peek)
if config.compression:
options.append("--%s" % config.compression)
if config.partial:
options.append("--partial")
if options:
get_wal_command = "get-wal %s '%s' '%s'" % (
" ".join(options),
config.server_name,
wal_name,
)
else:
get_wal_command = "get-wal '%s' '%s'" % (config.server_name, wal_name)
ssh_command.append(get_wal_command)
return ssh_command
def execute_peek(config):
"""
Invoke remote get-wal --peek to receive a list of wal file to copy
:param argparse.Namespace config: the configuration from command line
:returns set: a set of WAL file names from the peek command
"""
# Build the peek command
ssh_command = build_ssh_command(config, config.wal_name, config.parallel)
# Issue the command
try:
output = subprocess.Popen(ssh_command, stdout=subprocess.PIPE).communicate()
return list(output[0].decode().splitlines())
except subprocess.CalledProcessError as e:
exit_with_error("Impossible to invoke remote get-wal --peek: %s" % e)
def try_deliver_from_spool(config, dest_file):
"""
Search for the requested file in the spool directory.
If is already present, then copy it locally and exit,
return otherwise.
:param argparse.Namespace config: the configuration from command line
:param dest_file: The destination file object
"""
spool_file = os.path.join(config.spool_dir, config.wal_name)
# id the file is not present, give up
if not os.path.exists(spool_file):
return
try:
shutil.copyfileobj(open(spool_file, "rb"), dest_file)
os.unlink(spool_file)
sys.exit(0)
except IOError as e:
exit_with_error(
"Failure copying %s to %s: %s" % (spool_file, dest_file.name, e)
)
def exit_with_error(message, status=2, sleep=0):
"""
Print ``message`` and terminate the script with ``status``
:param str message: message to print
:param int status: script exit code
:param int sleep: second to sleep before exiting
"""
print("ERROR: %s" % message, file=sys.stderr)
# Sleep for config.sleep seconds if required
if sleep:
print("Sleeping for %d seconds." % sleep, file=sys.stderr)
time.sleep(sleep)
sys.exit(status)
def connectivity_test(config):
"""
Invoke remote get-wal --test to test the connection with Barman server
:param argparse.Namespace config: the configuration from command line
"""
# Build the peek command
ssh_command = build_ssh_command(config, "dummy_wal_name")
# Issue the command
try:
pipe = subprocess.Popen(
ssh_command, stdout=subprocess.PIPE, stderr=subprocess.STDOUT
)
output = pipe.communicate()
print(force_str(output[0]))
sys.exit(pipe.returncode)
except subprocess.CalledProcessError as e:
exit_with_error("Impossible to invoke remote get-wal: %s" % e)
def parse_arguments(args=None):
"""
Parse the command line arguments
:param list[str] args: the raw arguments list. When not provided
it defaults to sys.args[1:]
:rtype: argparse.Namespace
"""
parser = argparse.ArgumentParser(
description="This script will be used as a 'restore_command' "
"based on the get-wal feature of Barman. "
"A ssh connection will be opened to the Barman host.",
)
parser.add_argument(
"-V", "--version", action="version", version="%%(prog)s %s" % barman.__version__
)
parser.add_argument(
"-U",
"--user",
default=DEFAULT_USER,
help="The user used for the ssh connection to the Barman server. "
"Defaults to '%(default)s'.",
)
parser.add_argument(
"-s",
"--sleep",
default=0,
type=int,
metavar="SECONDS",
help="Sleep for SECONDS after a failure of get-wal request. "
"Defaults to 0 (nowait).",
)
parser.add_argument(
"-p",
"--parallel",
default=0,
type=int,
metavar="JOBS",
help="Specifies the number of files to peek and transfer "
"in parallel. "
"Defaults to 0 (disabled).",
)
parser.add_argument(
"--spool-dir",
default=DEFAULT_SPOOL_DIR,
metavar="SPOOL_DIR",
help="Specifies spool directory for WAL files. Defaults to "
"'{0}'.".format(DEFAULT_SPOOL_DIR),
)
parser.add_argument(
"-P",
"--partial",
help="retrieve also partial WAL files (.partial)",
action="store_true",
dest="partial",
default=False,
)
parser.add_argument(
"-z",
"--gzip",
help="Transfer the WAL files compressed with gzip",
action="store_const",
const="gzip",
dest="compression",
)
parser.add_argument(
"-j",
"--bzip2",
help="Transfer the WAL files compressed with bzip2",
action="store_const",
const="bzip2",
dest="compression",
)
parser.add_argument(
"-c",
"--config",
metavar="CONFIG",
help="configuration file on the Barman server",
)
parser.add_argument(
"-t",
"--test",
action="store_true",
help="test both the connection and the configuration of the "
"requested PostgreSQL server in Barman to make sure it is "
"ready to receive WAL files. With this option, "
"the 'wal_name' and 'wal_dest' mandatory arguments are ignored.",
)
parser.add_argument(
"barman_host",
metavar="BARMAN_HOST",
help="The host of the Barman server.",
)
parser.add_argument(
"server_name",
metavar="SERVER_NAME",
help="The server name configured in Barman from which WALs are taken.",
)
parser.add_argument(
"wal_name",
metavar="WAL_NAME",
help="The value of the '%%f' keyword (according to 'restore_command').",
)
parser.add_argument(
"wal_dest",
metavar="WAL_DEST",
help="The value of the '%%p' keyword (according to 'restore_command').",
)
return parser.parse_args(args=args)
class RemoteGetWal(object):
processes = set()
"""
The list of processes that has been spawned by RemoteGetWal
"""
def __init__(self, config, wal_name, dest_file):
"""
Spawn a process that download a WAL from remote.
If needed decompress the remote stream on the fly.
:param argparse.Namespace config: the configuration from command line
:param wal_name: The name of WAL to download
:param dest_file: The destination file name or a writable file object
"""
self.config = config
self.wal_name = wal_name
self.decompressor = None
self.dest_file = None
# If a string has been passed, it's the name of the destination file
# We convert it in a writable binary file object
if isinstance(dest_file, string_types):
self.dest_file = dest_file
dest_file = open(dest_file, "wb")
with dest_file:
# If compression has been required, we need to spawn two processes
if config.compression:
# Spawn a remote get-wal process
self.ssh_process = subprocess.Popen(
build_ssh_command(config, wal_name), stdout=subprocess.PIPE
)
# Spawn the local decompressor
self.decompressor = subprocess.Popen(
[config.compression, "-d"],
stdin=self.ssh_process.stdout,
stdout=dest_file,
)
# Close the pipe descriptor, letting the decompressor process
# to receive the SIGPIPE
self.ssh_process.stdout.close()
else:
# With no compression only the remote get-wal process
# is required
self.ssh_process = subprocess.Popen(
build_ssh_command(config, wal_name), stdout=dest_file
)
# Register the spawned processes in the class registry
self.processes.add(self.ssh_process)
if self.decompressor:
self.processes.add(self.decompressor)
@classmethod
def wait_for_all(cls):
"""
Wait for the termination of all the registered spawned processes.
"""
try:
while len(cls.processes):
time.sleep(0.1)
for process in cls.processes.copy():
if process.poll() is not None:
cls.processes.remove(process)
except KeyboardInterrupt:
# If a SIGINT has been received, make sure that every subprocess
# terminate
for process in cls.processes:
process.kill()
exit_with_error("SIGINT received! Terminating.")
@property
def returncode(self):
"""
Return the exit code of the RemoteGetWal processes.
A remote get-wal process return code is 0 only if both the remote
get-wal process and the eventual decompressor return 0
:return: exit code of the RemoteGetWal processes
"""
if self.ssh_process.returncode != 0:
return self.ssh_process.returncode
if self.decompressor:
if self.decompressor.returncode != 0:
return self.decompressor.returncode
return 0
if __name__ == "__main__":
main()
barman-2.18/barman/clients/cloud_backup_delete.py 0000644 0006212 0006212 00000031655 14172556763 020342 0 ustar 0000000 0000000 # -*- coding: utf-8 -*-
# © Copyright EnterpriseDB UK Limited 2018-2022
#
# This file is part of Barman.
#
# Barman is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Barman is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Barman. If not, see .
import logging
import os
from contextlib import closing
from operator import attrgetter
from barman.backup import BackupManager
from barman.clients.cloud_cli import (
create_argument_parser,
CLIErrorExit,
GeneralErrorExit,
NetworkErrorExit,
OperationErrorExit,
)
from barman.cloud import CloudBackupCatalog, configure_logging
from barman.cloud_providers import get_cloud_interface
from barman.exceptions import InvalidRetentionPolicy
from barman.retention_policies import RetentionPolicyFactory
from barman.utils import force_str
from barman import xlog
def _get_files_for_backup(catalog, backup_info):
backup_files = []
# Sort the files by OID so that we always get a stable order. The PGDATA dir
# has no OID so we use a -1 for sorting purposes, such that it always sorts
# ahead of the tablespaces.
for oid, backup_file in sorted(
catalog.get_backup_files(backup_info, allow_missing=True).items(),
key=lambda x: x[0] if x[0] else -1,
):
key = oid or "PGDATA"
for file_info in [backup_file] + sorted(
backup_file.additional_files, key=attrgetter("path")
):
# Silently skip files which could not be found - if they don't exist
# then not being able to delete them is not an error condition here
if file_info.path is not None:
logging.debug(
"Will delete archive for %s at %s" % (key, file_info.path)
)
backup_files.append(file_info.path)
return backup_files
def _remove_wals_for_backup(
cloud_interface,
catalog,
deleted_backup,
dry_run,
skip_wal_cleanup_if_standalone=True,
):
# An implementation of BackupManager.remove_wal_before_backup which does not
# use xlogdb, since xlogdb is not available to barman-cloud
should_remove_wals, wal_ranges_to_protect = BackupManager.should_remove_wals(
deleted_backup,
catalog.get_backup_list(),
keep_manager=catalog,
skip_wal_cleanup_if_standalone=skip_wal_cleanup_if_standalone,
)
next_backup = BackupManager.find_next_backup_in(
catalog.get_backup_list(), deleted_backup.backup_id
)
wals_to_delete = {}
if should_remove_wals:
# There is no previous backup or all previous backups are archival
# standalone backups, so we can remove unused WALs (those WALs not
# required by standalone archival backups).
# If there is a next backup then all unused WALs up to the begin_wal
# of the next backup can be removed.
# If there is no next backup then there are no remaining backups,
# because we must assume non-exclusive backups are taken, we can only
# safely delete unused WALs up to begin_wal of the deleted backup.
# See comments in barman.backup.BackupManager.delete_backup.
if next_backup:
remove_until = next_backup
else:
remove_until = deleted_backup
# A WAL is only a candidate for deletion if it is on the same timeline so we
# use BackupManager to get a set of all other timelines with backups so that
# we can preserve all WALs on other timelines.
timelines_to_protect = BackupManager.get_timelines_to_protect(
remove_until=remove_until,
deleted_backup=deleted_backup,
available_backups=catalog.get_backup_list(),
)
try:
wal_paths = catalog.get_wal_paths()
except Exception as exc:
logging.error(
"Cannot clean up WALs for backup %s because an error occurred listing WALs: %s",
deleted_backup.backup_id,
force_str(exc),
)
return
for wal_name, wal in wal_paths.items():
if xlog.is_history_file(wal_name):
continue
if timelines_to_protect:
tli, _, _ = xlog.decode_segment_name(wal_name)
if tli in timelines_to_protect:
continue
# Check if the WAL is in a protected range, required by an archival
# standalone backup - so do not delete it
if xlog.is_backup_file(wal_name):
# If we have a backup file, truncate the name for the range check
range_check_wal_name = wal_name[:24]
else:
range_check_wal_name = wal_name
if any(
range_check_wal_name >= begin_wal and range_check_wal_name <= end_wal
for begin_wal, end_wal in wal_ranges_to_protect
):
continue
if wal_name < remove_until.begin_wal:
wals_to_delete[wal_name] = wal
# Explicitly sort because dicts are not ordered in python < 3.6
wal_paths_to_delete = sorted(wals_to_delete.values())
if len(wal_paths_to_delete) > 0:
if not dry_run:
try:
cloud_interface.delete_objects(wal_paths_to_delete)
except Exception as exc:
logging.error(
"Could not delete the following WALs for backup %s: %s, Reason: %s",
deleted_backup.backup_id,
wal_paths_to_delete,
force_str(exc),
)
# Return early so that we leave the WALs in the local cache so they
# can be cleaned up should there be a subsequent backup deletion.
return
else:
print(
"Skipping deletion of objects %s due to --dry-run option"
% wal_paths_to_delete
)
for wal_name in wals_to_delete.keys():
catalog.remove_wal_from_cache(wal_name)
def _delete_backup(
cloud_interface,
catalog,
backup_id,
dry_run=True,
skip_wal_cleanup_if_standalone=True,
):
backup_info = catalog.get_backup_info(backup_id)
if not backup_info:
logging.warning("Backup %s does not exist", backup_id)
return
objects_to_delete = _get_files_for_backup(catalog, backup_info)
backup_info_path = os.path.join(
catalog.prefix, backup_info.backup_id, "backup.info"
)
logging.debug("Will delete backup.info file at %s" % backup_info_path)
if not dry_run:
try:
cloud_interface.delete_objects(objects_to_delete)
# Do not try to delete backup.info until we have successfully deleted
# everything else so that it is possible to retry the operation should
# we fail to delete any backup file
cloud_interface.delete_objects([backup_info_path])
except Exception as exc:
logging.error("Could not delete backup %s: %s", backup_id, force_str(exc))
raise OperationErrorExit()
else:
print(
"Skipping deletion of objects %s due to --dry-run option"
% (objects_to_delete + [backup_info_path])
)
_remove_wals_for_backup(
cloud_interface, catalog, backup_info, dry_run, skip_wal_cleanup_if_standalone
)
# It is important that the backup is removed from the catalog after cleaning
# up the WALs because the code in _remove_wals_for_backup depends on the
# deleted backup existing in the backup catalog
catalog.remove_backup_from_cache(backup_id)
def main(args=None):
"""
The main script entry point
:param list[str] args: the raw arguments list. When not provided
it defaults to sys.args[1:]
"""
config = parse_arguments(args)
configure_logging(config)
try:
cloud_interface = get_cloud_interface(config)
with closing(cloud_interface):
if not cloud_interface.test_connectivity():
raise NetworkErrorExit()
# If test is requested, just exit after connectivity test
elif config.test:
raise SystemExit(0)
if not cloud_interface.bucket_exists:
logging.error("Bucket %s does not exist", cloud_interface.bucket_name)
raise OperationErrorExit()
catalog = CloudBackupCatalog(
cloud_interface=cloud_interface, server_name=config.server_name
)
# Call catalog.get_backup_list now so we know we can read the whole catalog
# (the results are cached so this does not result in extra calls to cloud
# storage)
catalog.get_backup_list()
if len(catalog.unreadable_backups) > 0:
logging.error(
"Cannot read the following backups: %s\n"
"Unsafe to proceed with deletion due to failure reading backup catalog"
% catalog.unreadable_backups
)
raise OperationErrorExit()
if config.backup_id:
# Because we only care about one backup, skip the annotation cache
# because it is only helpful when dealing with multiple backups
if catalog.should_keep_backup(config.backup_id, use_cache=False):
logging.error(
"Skipping delete of backup %s for server %s "
"as it has a current keep request. If you really "
"want to delete this backup please remove the keep "
"and try again.",
config.backup_id,
config.server_name,
)
raise OperationErrorExit()
_delete_backup(
cloud_interface, catalog, config.backup_id, config.dry_run
)
elif config.retention_policy:
try:
retention_policy = RetentionPolicyFactory.create(
"retention_policy",
config.retention_policy,
server_name=config.server_name,
catalog=catalog,
)
except InvalidRetentionPolicy as exc:
logging.error(
"Could not create retention policy %s: %s",
config.retention_policy,
force_str(exc),
)
raise CLIErrorExit()
# Sort to ensure that we delete the backups in ascending order, that is
# from oldest to newest. This ensures that the relevant WALs will be cleaned
# up after each backup is deleted.
backups_to_delete = sorted(
[
backup_id
for backup_id, status in retention_policy.report().items()
if status == "OBSOLETE"
]
)
for backup_id in backups_to_delete:
_delete_backup(
cloud_interface,
catalog,
backup_id,
config.dry_run,
skip_wal_cleanup_if_standalone=False,
)
except Exception as exc:
logging.error("Barman cloud backup delete exception: %s", force_str(exc))
logging.debug("Exception details:", exc_info=exc)
raise GeneralErrorExit()
def parse_arguments(args=None):
"""
Parse command line arguments
:return: The options parsed
"""
parser, _, _ = create_argument_parser(
description="This script can be used to delete backups "
"made with barman-cloud-backup command. "
"Currently AWS S3 and Azure Blob Storage are supported.",
)
delete_arguments = parser.add_mutually_exclusive_group(required=True)
delete_arguments.add_argument(
"-b",
"--backup-id",
help="Backup ID of the backup to be deleted",
)
delete_arguments.add_argument(
"-r",
"--retention-policy",
help="If specified, delete all backups eligible for deletion according to the "
"supplied retention policy. Syntax: REDUNDANCY value | RECOVERY WINDOW OF "
"value {DAYS | WEEKS | MONTHS}",
)
parser.add_argument(
"--dry-run",
action="store_true",
help="Find the objects which need to be deleted but do not delete them",
)
return parser.parse_args(args=args)
if __name__ == "__main__":
main()
barman-2.18/barman/clients/cloud_walarchive.py 0000755 0006212 0006212 00000024736 14172556763 017705 0 ustar 0000000 0000000 # -*- coding: utf-8 -*-
# © Copyright EnterpriseDB UK Limited 2018-2022
#
# This file is part of Barman.
#
# Barman is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Barman is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Barman. If not, see .
import logging
import os
import os.path
from contextlib import closing
from barman.clients.cloud_cli import (
add_tag_argument,
create_argument_parser,
CLIErrorExit,
GeneralErrorExit,
NetworkErrorExit,
UrlArgumentType,
)
from barman.cloud import configure_logging
from barman.clients.cloud_compression import compress
from barman.cloud_providers import get_cloud_interface
from barman.exceptions import BarmanException
from barman.utils import check_positive, check_size, force_str
from barman.xlog import hash_dir, is_any_xlog_file, is_history_file
def __is_hook_script():
"""Check the environment and determine if we are running as a hook script"""
if "BARMAN_HOOK" in os.environ and "BARMAN_PHASE" in os.environ:
if (
os.getenv("BARMAN_HOOK") in ("archive_script", "archive_retry_script")
and os.getenv("BARMAN_PHASE") == "pre"
):
return True
else:
raise BarmanException(
"barman-cloud-wal-archive called as unsupported hook script: %s_%s"
% (os.getenv("BARMAN_PHASE"), os.getenv("BARMAN_HOOK"))
)
else:
return False
def main(args=None):
"""
The main script entry point
:param list[str] args: the raw arguments list. When not provided
it defaults to sys.args[1:]
"""
config = parse_arguments(args)
configure_logging(config)
# Read wal_path from environment if we're a hook script
if __is_hook_script():
if "BARMAN_FILE" not in os.environ:
raise BarmanException("Expected environment variable BARMAN_FILE not set")
config.wal_path = os.getenv("BARMAN_FILE")
else:
if config.wal_path is None:
raise BarmanException("the following arguments are required: wal_path")
# Validate the WAL file name before uploading it
if not is_any_xlog_file(config.wal_path):
logging.error("%s is an invalid name for a WAL file" % config.wal_path)
raise CLIErrorExit()
try:
cloud_interface = get_cloud_interface(config)
with closing(cloud_interface):
uploader = CloudWalUploader(
cloud_interface=cloud_interface,
server_name=config.server_name,
compression=config.compression,
)
if not cloud_interface.test_connectivity():
raise NetworkErrorExit()
# If test is requested, just exit after connectivity test
elif config.test:
raise SystemExit(0)
# TODO: Should the setup be optional?
cloud_interface.setup_bucket()
upload_kwargs = {}
if is_history_file(config.wal_path):
upload_kwargs["override_tags"] = config.history_tags
uploader.upload_wal(config.wal_path, **upload_kwargs)
except Exception as exc:
logging.error("Barman cloud WAL archiver exception: %s", force_str(exc))
logging.debug("Exception details:", exc_info=exc)
raise GeneralErrorExit()
def parse_arguments(args=None):
"""
Parse command line arguments
:return: The options parsed
"""
parser, s3_arguments, azure_arguments = create_argument_parser(
description="This script can be used in the `archive_command` "
"of a PostgreSQL server to ship WAL files to the Cloud. "
"Currently AWS S3 and Azure Blob Storage are supported.",
source_or_destination=UrlArgumentType.destination,
)
parser.add_argument(
"wal_path",
nargs="?",
help="the value of the '%%p' keyword (according to 'archive_command').",
default=None,
)
compression = parser.add_mutually_exclusive_group()
compression.add_argument(
"-z",
"--gzip",
help="gzip-compress the WAL while uploading to the cloud "
"(should not be used with python < 3.2)",
action="store_const",
const="gzip",
dest="compression",
)
compression.add_argument(
"-j",
"--bzip2",
help="bzip2-compress the WAL while uploading to the cloud "
"(should not be used with python < 3.3)",
action="store_const",
const="bzip2",
dest="compression",
)
compression.add_argument(
"--snappy",
help="snappy-compress the WAL while uploading to the cloud "
"(requires optional python-snappy library)",
action="store_const",
const="snappy",
dest="compression",
)
add_tag_argument(
parser,
name="tags",
help="Tags to be added to archived WAL files in cloud storage",
)
add_tag_argument(
parser,
name="history-tags",
help="Tags to be added to archived history files in cloud storage",
)
s3_arguments.add_argument(
"-e",
"--encryption",
help="The encryption algorithm used when storing the uploaded data in S3. "
"Allowed values: 'AES256'|'aws:kms'.",
choices=["AES256", "aws:kms"],
metavar="ENCRYPTION",
)
azure_arguments.add_argument(
"--encryption-scope",
help="The name of an encryption scope defined in the Azure Blob Storage "
"service which is to be used to encrypt the data in Azure",
)
azure_arguments.add_argument(
"--max-block-size",
help="The chunk size to be used when uploading an object via the "
"concurrent chunk method (default: 4MB).",
type=check_size,
default="4MB",
)
azure_arguments.add_argument(
"--max-concurrency",
help="The maximum number of chunks to be uploaded concurrently (default: 1).",
type=check_positive,
default=1,
)
azure_arguments.add_argument(
"--max-single-put-size",
help="Maximum size for which the Azure client will upload an object in a "
"single request (default: 64MB). If this is set lower than the PostgreSQL "
"WAL segment size after any applied compression then the concurrent chunk "
"upload method for WAL archiving will be used.",
default="64MB",
type=check_size,
)
return parser.parse_args(args=args)
class CloudWalUploader(object):
"""
Cloud storage upload client
"""
def __init__(self, cloud_interface, server_name, compression=None):
"""
Object responsible for handling interactions with cloud storage
:param CloudInterface cloud_interface: The interface to use to
upload the backup
:param str server_name: The name of the server as configured in Barman
:param str compression: Compression algorithm to use
"""
self.cloud_interface = cloud_interface
self.compression = compression
self.server_name = server_name
def upload_wal(self, wal_path, override_tags=None):
"""
Upload a WAL file from postgres to cloud storage
:param str wal_path: Full path of the WAL file
:param List[tuple] override_tags: List of k,v tuples which should override any
tags already defined in the cloud interface
"""
# Extract the WAL file
wal_name = self.retrieve_wal_name(wal_path)
# Use the correct file object for the upload (simple|gzip|bz2)
file_object = self.retrieve_file_obj(wal_path)
# Correctly format the destination path
destination = os.path.join(
self.cloud_interface.path,
self.server_name,
"wals",
hash_dir(wal_path),
wal_name,
)
# Put the file in the correct bucket.
# The put method will handle automatically multipart upload
self.cloud_interface.upload_fileobj(
fileobj=file_object, key=destination, override_tags=override_tags
)
def retrieve_file_obj(self, wal_path):
"""
Create the correct type of file object necessary for the file transfer.
If no compression is required a simple File object is returned.
In case of compression, a BytesIO object is returned, containing the
result of the compression.
NOTE: the Wal files are actually compressed straight into memory,
thanks to the usual small dimension of the WAL.
This could change in the future because the WAL files dimension could
be more than 16MB on some postgres install.
TODO: Evaluate using tempfile if the WAL is bigger than 16MB
:param str wal_path:
:return File: simple or compressed file object
"""
# Read the wal_file in binary mode
wal_file = open(wal_path, "rb")
# return the opened file if is uncompressed
if not self.compression:
return wal_file
return compress(wal_file, self.compression)
def retrieve_wal_name(self, wal_path):
"""
Extract the name of the WAL file from the complete path.
If no compression is specified, then the simple file name is returned.
In case of compression, the correct file extension is applied to the
WAL file name.
:param str wal_path: the WAL file complete path
:return str: WAL file name
"""
# Extract the WAL name
wal_name = os.path.basename(wal_path)
# return the plain file name if no compression is specified
if not self.compression:
return wal_name
if self.compression == "gzip":
# add gz extension
return "%s.gz" % wal_name
elif self.compression == "bzip2":
# add bz2 extension
return "%s.bz2" % wal_name
elif self.compression == "snappy":
# add snappy extension
return "%s.snappy" % wal_name
else:
raise ValueError("Unknown compression type: %s" % self.compression)
if __name__ == "__main__":
main()
barman-2.18/barman/clients/cloud_check_wal_archive.py 0000644 0006212 0006212 00000005717 14172556763 021174 0 ustar 0000000 0000000 # -*- coding: utf-8 -*-
# © Copyright EnterpriseDB UK Limited 2018-2022
#
# This file is part of Barman.
#
# Barman is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Barman is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Barman. If not, see .
import logging
from barman.clients.cloud_cli import (
create_argument_parser,
GeneralErrorExit,
OperationErrorExit,
NetworkErrorExit,
UrlArgumentType,
)
from barman.cloud import configure_logging, CloudBackupCatalog
from barman.cloud_providers import get_cloud_interface
from barman.exceptions import WalArchiveContentError
from barman.utils import force_str, check_positive
from barman.xlog import check_archive_usable
def main(args=None):
"""
The main script entry point
:param list[str] args: the raw arguments list. When not provided
it defaults to sys.args[1:]
"""
config = parse_arguments(args)
configure_logging(config)
try:
cloud_interface = get_cloud_interface(config)
if not cloud_interface.test_connectivity():
# Deliberately raise an error if we cannot connect
raise NetworkErrorExit()
if not cloud_interface.bucket_exists:
# If the bucket does not exist then the check should pass
return
catalog = CloudBackupCatalog(cloud_interface, config.server_name)
wals = list(catalog.get_wal_paths().keys())
check_archive_usable(
wals,
timeline=config.timeline,
)
except WalArchiveContentError as err:
logging.error(
"WAL archive check failed for server %s: %s",
config.server_name,
force_str(err),
)
raise OperationErrorExit()
except Exception as exc:
logging.error("Barman cloud WAL archive check exception: %s", force_str(exc))
logging.debug("Exception details:", exc_info=exc)
raise GeneralErrorExit()
def parse_arguments(args=None):
"""
Parse command line arguments
:return: The options parsed
"""
parser, _, _ = create_argument_parser(
description="Checks that the WAL archive on the specified cloud storage "
"can be safely used for a new PostgreSQL server.",
source_or_destination=UrlArgumentType.destination,
)
parser.add_argument(
"--timeline",
help="The earliest timeline whose WALs should cause the check to fail",
type=check_positive,
)
return parser.parse_args(args=args)
if __name__ == "__main__":
main()
barman-2.18/barman/clients/cloud_restore.py 0000644 0006212 0006212 00000020526 14172556763 017231 0 ustar 0000000 0000000 # -*- coding: utf-8 -*-
# © Copyright EnterpriseDB UK Limited 2018-2022
#
# This file is part of Barman.
#
# Barman is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Barman is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Barman. If not, see .
import logging
import os
from contextlib import closing
from barman.clients.cloud_cli import (
CLIErrorExit,
create_argument_parser,
GeneralErrorExit,
NetworkErrorExit,
OperationErrorExit,
)
from barman.cloud import CloudBackupCatalog, configure_logging
from barman.cloud_providers import get_cloud_interface
from barman.utils import force_str
def main(args=None):
"""
The main script entry point
:param list[str] args: the raw arguments list. When not provided
it defaults to sys.args[1:]
"""
config = parse_arguments(args)
configure_logging(config)
# Validate the destination directory before starting recovery
if os.path.exists(config.recovery_dir) and os.listdir(config.recovery_dir):
logging.error(
"Destination %s already exists and it is not empty", config.recovery_dir
)
raise OperationErrorExit()
try:
cloud_interface = get_cloud_interface(config)
with closing(cloud_interface):
downloader = CloudBackupDownloader(
cloud_interface=cloud_interface, server_name=config.server_name
)
if not cloud_interface.test_connectivity():
raise NetworkErrorExit()
# If test is requested, just exit after connectivity test
elif config.test:
raise SystemExit(0)
if not cloud_interface.bucket_exists:
logging.error("Bucket %s does not exist", cloud_interface.bucket_name)
raise OperationErrorExit()
downloader.download_backup(
config.backup_id,
config.recovery_dir,
tablespace_map(config.tablespace),
)
except KeyboardInterrupt as exc:
logging.error("Barman cloud restore was interrupted by the user")
logging.debug("Exception details:", exc_info=exc)
raise OperationErrorExit()
except Exception as exc:
logging.error("Barman cloud restore exception: %s", force_str(exc))
logging.debug("Exception details:", exc_info=exc)
raise GeneralErrorExit()
def parse_arguments(args=None):
"""
Parse command line arguments
:return: The options parsed
"""
parser, _, _ = create_argument_parser(
description="This script can be used to download a backup "
"previously made with barman-cloud-backup command."
"Currently AWS S3 and Azure Blob Storage are supported.",
)
parser.add_argument("backup_id", help="the backup ID")
parser.add_argument("recovery_dir", help="the path to a directory for recovery.")
parser.add_argument(
"--tablespace",
help="tablespace relocation rule",
metavar="NAME:LOCATION",
action="append",
default=[],
)
return parser.parse_args(args=args)
def tablespace_map(rules):
"""
Return a mapping from tablespace names to locations built from any
`--tablespace name:/loc/ation` rules specified.
"""
tablespaces = {}
for rule in rules:
try:
tablespaces.update([rule.split(":", 1)])
except ValueError:
logging.error(
"Invalid tablespace relocation rule '%s'\n"
"HINT: The valid syntax for a relocation rule is "
"NAME:LOCATION",
rule,
)
raise CLIErrorExit()
return tablespaces
class CloudBackupDownloader(object):
"""
Cloud storage download client
"""
def __init__(self, cloud_interface, server_name):
"""
Object responsible for handling interactions with cloud storage
:param CloudInterface cloud_interface: The interface to use to
upload the backup
:param str server_name: The name of the server as configured in Barman
"""
self.cloud_interface = cloud_interface
self.server_name = server_name
self.catalog = CloudBackupCatalog(cloud_interface, server_name)
def download_backup(self, backup_id, destination_dir, tablespaces):
"""
Download a backup from cloud storage
:param str backup_id: The backup id to restore
:param str destination_dir: Path to the destination directory
"""
backup_info = self.catalog.get_backup_info(backup_id)
if not backup_info:
logging.error(
"Backup %s for server %s does not exists", backup_id, self.server_name
)
raise OperationErrorExit()
backup_files = self.catalog.get_backup_files(backup_info)
# We must download and restore a bunch of .tar files that contain PGDATA
# and each tablespace. First, we determine a target directory to extract
# each tar file into and record these in copy_jobs. For each tablespace,
# the location may be overriden by `--tablespace name:/new/location` on
# the command-line; and we must also add an entry to link_jobs to create
# a symlink from $PGDATA/pg_tblspc/oid to the correct location after the
# downloads.
copy_jobs = []
link_jobs = []
for oid in backup_files:
file_info = backup_files[oid]
# PGDATA is restored where requested (destination_dir)
if oid is None:
target_dir = destination_dir
else:
for tblspc in backup_info.tablespaces:
if oid == tblspc.oid:
target_dir = tblspc.location
if tblspc.name in tablespaces:
target_dir = os.path.realpath(tablespaces[tblspc.name])
logging.debug(
"Tablespace %s (oid=%s) will be located at %s",
tblspc.name,
oid,
target_dir,
)
link_jobs.append(
["%s/pg_tblspc/%s" % (destination_dir, oid), target_dir]
)
break
else:
raise AssertionError(
"The backup file oid '%s' must be present "
"in backupinfo.tablespaces list"
)
# Validate the destination directory before starting recovery
if os.path.exists(target_dir) and os.listdir(target_dir):
logging.error(
"Destination %s already exists and it is not empty", target_dir
)
raise OperationErrorExit()
copy_jobs.append([file_info, target_dir])
for additional_file in file_info.additional_files:
copy_jobs.append([additional_file, target_dir])
# Now it's time to download the files
for file_info, target_dir in copy_jobs:
# Download the file
logging.debug(
"Extracting %s to %s (%s)",
file_info.path,
target_dir,
"decompressing " + file_info.compression
if file_info.compression
else "no compression",
)
self.cloud_interface.extract_tar(file_info.path, target_dir)
for link, target in link_jobs:
os.symlink(target, link)
# If we did not restore the pg_wal directory from one of the uploaded
# backup files, we must recreate it here. (If pg_wal was originally a
# symlink, it would not have been uploaded.)
wal_path = os.path.join(destination_dir, backup_info.wal_directory())
if not os.path.exists(wal_path):
os.mkdir(wal_path)
if __name__ == "__main__":
main()
barman-2.18/barman/clients/cloud_walrestore.py 0000644 0006212 0006212 00000015033 14172556763 017732 0 ustar 0000000 0000000 # -*- coding: utf-8 -*-
# © Copyright EnterpriseDB UK Limited 2018-2022
#
# This file is part of Barman.
#
# Barman is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Barman is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Barman. If not, see .
import logging
import os
import sys
from contextlib import closing
from barman.clients.cloud_cli import (
create_argument_parser,
CLIErrorExit,
GeneralErrorExit,
NetworkErrorExit,
OperationErrorExit,
)
from barman.cloud import configure_logging, ALLOWED_COMPRESSIONS
from barman.cloud_providers import get_cloud_interface
from barman.exceptions import BarmanException
from barman.utils import force_str
from barman.xlog import hash_dir, is_any_xlog_file, is_backup_file
def main(args=None):
"""
The main script entry point
:param list[str] args: the raw arguments list. When not provided
it defaults to sys.args[1:]
"""
config = parse_arguments(args)
configure_logging(config)
# Validate the WAL file name before downloading it
if not is_any_xlog_file(config.wal_name):
logging.error("%s is an invalid name for a WAL file" % config.wal_name)
raise CLIErrorExit()
try:
cloud_interface = get_cloud_interface(config)
with closing(cloud_interface):
downloader = CloudWalDownloader(
cloud_interface=cloud_interface, server_name=config.server_name
)
if not cloud_interface.test_connectivity():
raise NetworkErrorExit()
# If test is requested, just exit after connectivity test
elif config.test:
raise SystemExit(0)
if not cloud_interface.bucket_exists:
logging.error("Bucket %s does not exist", cloud_interface.bucket_name)
raise OperationErrorExit()
downloader.download_wal(config.wal_name, config.wal_dest)
except Exception as exc:
logging.error("Barman cloud WAL restore exception: %s", force_str(exc))
logging.debug("Exception details:", exc_info=exc)
raise GeneralErrorExit()
def parse_arguments(args=None):
"""
Parse command line arguments
:return: The options parsed
"""
parser, _, _ = create_argument_parser(
description="This script can be used as a `restore_command` "
"to download WAL files previously archived with "
"barman-cloud-wal-archive command. "
"Currently AWS S3 and Azure Blob Storage are supported.",
)
parser.add_argument(
"wal_name",
help="The value of the '%%f' keyword (according to 'restore_command').",
)
parser.add_argument(
"wal_dest",
help="The value of the '%%p' keyword (according to 'restore_command').",
)
return parser.parse_args(args=args)
class CloudWalDownloader(object):
"""
Cloud storage download client
"""
def __init__(self, cloud_interface, server_name):
"""
Object responsible for handling interactions with cloud storage
:param CloudInterface cloud_interface: The interface to use to
upload the backup
:param str server_name: The name of the server as configured in Barman
"""
self.cloud_interface = cloud_interface
self.server_name = server_name
def download_wal(self, wal_name, wal_dest):
"""
Download a WAL file from cloud storage
:param str wal_name: Name of the WAL file
:param str wal_dest: Full path of the destination WAL file
"""
# Correctly format the source path on s3
source_dir = os.path.join(
self.cloud_interface.path, self.server_name, "wals", hash_dir(wal_name)
)
# Add a path separator if needed
if not source_dir.endswith(os.path.sep):
source_dir += os.path.sep
wal_path = os.path.join(source_dir, wal_name)
remote_name = None
# Automatically detect compression based on the file extension
compression = None
for item in self.cloud_interface.list_bucket(source_dir):
# perfect match (uncompressed file)
if item == wal_path:
remote_name = item
# look for compressed files or .partial files
elif item.startswith(wal_path):
# Detect compression
basename = item
for e, c in ALLOWED_COMPRESSIONS.items():
if item[-len(e) :] == e:
# Strip extension
basename = basename[: -len(e)]
compression = c
break
# Check basename is a known xlog file (.partial?)
if not is_any_xlog_file(basename):
logging.warning("Unknown WAL file: %s", item)
continue
# Exclude backup informative files (not needed in recovery)
elif is_backup_file(basename):
logging.info("Skipping backup file: %s", item)
continue
# Found candidate
remote_name = item
logging.info(
"Found WAL %s for server %s as %s",
wal_name,
self.server_name,
remote_name,
)
break
if not remote_name:
logging.info(
"WAL file %s for server %s does not exists", wal_name, self.server_name
)
raise OperationErrorExit()
if compression and sys.version_info < (3, 0, 0):
raise BarmanException(
"Compressed WALs cannot be restored with Python 2.x - "
"please upgrade to a supported version of Python 3"
)
# Download the file
logging.debug(
"Downloading %s to %s (%s)",
remote_name,
wal_dest,
"decompressing " + compression if compression else "no compression",
)
self.cloud_interface.download_file(remote_name, wal_dest, compression)
if __name__ == "__main__":
main()
barman-2.18/barman/clients/walarchive.py 0000755 0006212 0006212 00000025436 14172556763 016515 0 ustar 0000000 0000000 # -*- coding: utf-8 -*-
# walarchive - Remote Barman WAL archive command for PostgreSQL
#
# This script remotely sends WAL files to Barman via SSH, on demand.
# It is intended to be used as archive_command in PostgreSQL configuration.
#
# See the help page for usage information.
#
# © Copyright EnterpriseDB UK Limited 2019-2022
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see .
from __future__ import print_function
import argparse
import copy
import hashlib
import os
import subprocess
import sys
import tarfile
import time
from contextlib import closing
from io import BytesIO
import barman
DEFAULT_USER = "barman"
BUFSIZE = 16 * 1024
def main(args=None):
"""
The main script entry point
:param list[str] args: the raw arguments list. When not provided
it defaults to sys.args[1:]
"""
config = parse_arguments(args)
# Do connectivity test if requested
if config.test:
connectivity_test(config)
return # never reached
# Check WAL destination is not a directory
if os.path.isdir(config.wal_path):
exit_with_error("WAL_PATH cannot be a directory: %s" % config.wal_path)
try:
# Execute barman put-wal through the ssh connection
ssh_process = RemotePutWal(config, config.wal_path)
except EnvironmentError as exc:
exit_with_error("Error executing ssh: %s" % exc)
return # never reached
# Wait for termination of every subprocess. If CTRL+C is pressed,
# terminate all of them
RemotePutWal.wait_for_all()
# If the command succeeded exit here
if ssh_process.returncode == 0:
return
# Report the exit code, remapping ssh failure code (255) to 3
if ssh_process.returncode == 255:
exit_with_error("Connection problem with ssh", 3)
else:
exit_with_error(
"Remote 'barman put-wal' command has failed!", ssh_process.returncode
)
def build_ssh_command(config):
"""
Prepare an ssh command according to the arguments passed on command line
:param argparse.Namespace config: the configuration from command line
:return list[str]: the ssh command as list of string
"""
ssh_command = [
"ssh",
"-q", # quiet mode - suppress warnings
"-T", # disable pseudo-terminal allocation
"%s@%s" % (config.user, config.barman_host),
"barman",
]
if config.config:
ssh_command.append("--config='%s'" % config.config)
ssh_command.extend(["put-wal", config.server_name])
if config.test:
ssh_command.append("--test")
return ssh_command
def exit_with_error(message, status=2):
"""
Print ``message`` and terminate the script with ``status``
:param str message: message to print
:param int status: script exit code
"""
print("ERROR: %s" % message, file=sys.stderr)
sys.exit(status)
def connectivity_test(config):
"""
Invoke remote put-wal --test to test the connection with Barman server
:param argparse.Namespace config: the configuration from command line
"""
ssh_command = build_ssh_command(config)
try:
output = subprocess.Popen(ssh_command, stdout=subprocess.PIPE).communicate()
print(output[0].decode("utf-8"))
sys.exit(0)
except subprocess.CalledProcessError as e:
exit_with_error("Impossible to invoke remote put-wal: %s" % e)
def parse_arguments(args=None):
"""
Parse the command line arguments
:param list[str] args: the raw arguments list. When not provided
it defaults to sys.args[1:]
:rtype: argparse.Namespace
"""
parser = argparse.ArgumentParser(
description="This script will be used as an 'archive_command' "
"based on the put-wal feature of Barman. "
"A ssh connection will be opened to the Barman host.",
)
parser.add_argument(
"-V", "--version", action="version", version="%%(prog)s %s" % barman.__version__
)
parser.add_argument(
"-U",
"--user",
default=DEFAULT_USER,
help="The user used for the ssh connection to the Barman server. "
"Defaults to '%(default)s'.",
)
parser.add_argument(
"-c",
"--config",
metavar="CONFIG",
help="configuration file on the Barman server",
)
parser.add_argument(
"-t",
"--test",
action="store_true",
help="test both the connection and the configuration of the "
"requested PostgreSQL server in Barman for WAL retrieval. "
"With this option, the 'wal_name' mandatory argument is "
"ignored.",
)
parser.add_argument(
"barman_host",
metavar="BARMAN_HOST",
help="The host of the Barman server.",
)
parser.add_argument(
"server_name",
metavar="SERVER_NAME",
help="The server name configured in Barman from which WALs are taken.",
)
parser.add_argument(
"wal_path",
metavar="WAL_PATH",
help="The value of the '%%p' keyword (according to 'archive_command').",
)
return parser.parse_args(args=args)
def md5copyfileobj(src, dst, length=None):
"""
Copy length bytes from fileobj src to fileobj dst.
If length is None, copy the entire content.
This method is used by the ChecksumTarFile.addfile().
Returns the md5 checksum
"""
checksum = hashlib.md5()
if length == 0:
return checksum.hexdigest()
if length is None:
while 1:
buf = src.read(BUFSIZE)
if not buf:
break
checksum.update(buf)
dst.write(buf)
return checksum.hexdigest()
blocks, remainder = divmod(length, BUFSIZE)
for _ in range(blocks):
buf = src.read(BUFSIZE)
if len(buf) < BUFSIZE:
raise IOError("end of file reached")
checksum.update(buf)
dst.write(buf)
if remainder != 0:
buf = src.read(remainder)
if len(buf) < remainder:
raise IOError("end of file reached")
checksum.update(buf)
dst.write(buf)
return checksum.hexdigest()
class ChecksumTarInfo(tarfile.TarInfo):
"""
Special TarInfo that can hold a file checksum
"""
def __init__(self, *args, **kwargs):
super(ChecksumTarInfo, self).__init__(*args, **kwargs)
self.data_checksum = None
class ChecksumTarFile(tarfile.TarFile):
"""
Custom TarFile class that automatically calculates md5 checksum
of each file and appends a file called 'MD5SUMS' to the stream.
"""
tarinfo = ChecksumTarInfo # The default TarInfo class used by TarFile
format = tarfile.PAX_FORMAT # Use PAX format to better preserve metadata
MD5SUMS_FILE = "MD5SUMS"
def addfile(self, tarinfo, fileobj=None):
"""
Add the provided fileobj to the tar using md5copyfileobj
and saves the file md5 in the provided ChecksumTarInfo object.
This method completely replaces TarFile.addfile()
"""
self._check("aw")
tarinfo = copy.copy(tarinfo)
buf = tarinfo.tobuf(self.format, self.encoding, self.errors)
self.fileobj.write(buf)
self.offset += len(buf)
# If there's data to follow, append it.
if fileobj is not None:
tarinfo.data_checksum = md5copyfileobj(fileobj, self.fileobj, tarinfo.size)
blocks, remainder = divmod(tarinfo.size, tarfile.BLOCKSIZE)
if remainder > 0:
self.fileobj.write(tarfile.NUL * (tarfile.BLOCKSIZE - remainder))
blocks += 1
self.offset += blocks * tarfile.BLOCKSIZE
self.members.append(tarinfo)
def close(self):
"""
Add an MD5SUMS file to the tar just before closing.
This method extends TarFile.close().
"""
if self.closed:
return
if self.mode in "aw":
with BytesIO() as md5sums:
for tarinfo in self.members:
line = "%s *%s\n" % (tarinfo.data_checksum, tarinfo.name)
md5sums.write(line.encode())
md5sums.seek(0, os.SEEK_END)
size = md5sums.tell()
md5sums.seek(0, os.SEEK_SET)
tarinfo = self.tarinfo(self.MD5SUMS_FILE)
tarinfo.size = size
self.addfile(tarinfo, md5sums)
super(ChecksumTarFile, self).close()
class RemotePutWal(object):
"""
Spawn a process that sends a WAL to a remote Barman server.
:param argparse.Namespace config: the configuration from command line
:param wal_path: The name of WAL to upload
"""
processes = set()
"""
The list of processes that has been spawned by RemotePutWal
"""
def __init__(self, config, wal_path):
self.config = config
self.wal_path = wal_path
self.dest_file = None
# Spawn a remote put-wal process
self.ssh_process = subprocess.Popen(
build_ssh_command(config), stdin=subprocess.PIPE
)
# Register the spawned processes in the class registry
self.processes.add(self.ssh_process)
# Send the data as a tar file (containing checksums)
with self.ssh_process.stdin as dest_file:
with closing(ChecksumTarFile.open(mode="w|", fileobj=dest_file)) as tar:
tar.add(wal_path, os.path.basename(wal_path))
@classmethod
def wait_for_all(cls):
"""
Wait for the termination of all the registered spawned processes.
"""
try:
while cls.processes:
time.sleep(0.1)
for process in cls.processes.copy():
if process.poll() is not None:
cls.processes.remove(process)
except KeyboardInterrupt:
# If a SIGINT has been received, make sure that every subprocess
# terminate
for process in cls.processes:
process.kill()
exit_with_error("SIGINT received! Terminating.")
@property
def returncode(self):
"""
Return the exit code of the RemoteGetWal processes.
:return: exit code of the RemoteGetWal processes
"""
if self.ssh_process.returncode != 0:
return self.ssh_process.returncode
return 0
if __name__ == "__main__":
main()
barman-2.18/barman/clients/cloud_backup_list.py 0000644 0006212 0006212 00000010231 14172556763 020036 0 ustar 0000000 0000000 # -*- coding: utf-8 -*-
# © Copyright EnterpriseDB UK Limited 2018-2022
#
# This file is part of Barman.
#
# Barman is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Barman is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Barman. If not, see .
import json
import logging
from contextlib import closing
from barman.clients.cloud_cli import (
create_argument_parser,
GeneralErrorExit,
NetworkErrorExit,
OperationErrorExit,
)
from barman.cloud import CloudBackupCatalog, configure_logging
from barman.cloud_providers import get_cloud_interface
from barman.infofile import BackupInfo
from barman.utils import force_str
def main(args=None):
"""
The main script entry point
:param list[str] args: the raw arguments list. When not provided
it defaults to sys.args[1:]
"""
config = parse_arguments(args)
configure_logging(config)
try:
cloud_interface = get_cloud_interface(config)
with closing(cloud_interface):
catalog = CloudBackupCatalog(
cloud_interface=cloud_interface, server_name=config.server_name
)
if not cloud_interface.test_connectivity():
raise NetworkErrorExit()
# If test is requested, just exit after connectivity test
elif config.test:
raise SystemExit(0)
if not cloud_interface.bucket_exists:
logging.error("Bucket %s does not exist", cloud_interface.bucket_name)
raise OperationErrorExit()
backup_list = catalog.get_backup_list()
# Output
if config.format == "console":
COLUMNS = "{:<20}{:<25}{:<30}{:<16}"
print(
COLUMNS.format(
"Backup ID", "End Time", "Begin Wal", "Archival Status"
)
)
for backup_id in sorted(backup_list):
item = backup_list[backup_id]
if item and item.status == BackupInfo.DONE:
keep_target = catalog.get_keep_target(item.backup_id)
keep_status = (
keep_target and "KEEP:%s" % keep_target.upper() or ""
)
print(
COLUMNS.format(
item.backup_id,
item.end_time.strftime("%Y-%m-%d %H:%M:%S"),
item.begin_wal,
keep_status,
)
)
else:
print(
json.dumps(
{
"backups_list": [
backup_list[backup_id].to_json()
for backup_id in sorted(backup_list)
]
}
)
)
except Exception as exc:
logging.error("Barman cloud backup list exception: %s", force_str(exc))
logging.debug("Exception details:", exc_info=exc)
raise GeneralErrorExit()
def parse_arguments(args=None):
"""
Parse command line arguments
:return: The options parsed
"""
parser, _, _ = create_argument_parser(
description="This script can be used to list backups "
"made with barman-cloud-backup command. "
"Currently AWS S3 and Azure Blob Storage are supported.",
)
parser.add_argument(
"--format",
default="console",
help="Output format (console or json). Default console.",
)
return parser.parse_args(args=args)
if __name__ == "__main__":
main()
barman-2.18/barman/storage/ 0000755 0006212 0006212 00000000000 14172556766 014007 5 ustar 0000000 0000000 barman-2.18/barman/storage/__init__.py 0000644 0006212 0006212 00000001324 14172556763 016115 0 ustar 0000000 0000000 # -*- coding: utf-8 -*-
# © Copyright EnterpriseDB UK Limited 2013-2022
#
# This file is part of Barman.
#
# Barman is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Barman is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Barman. If not, see .
barman-2.18/barman/storage/file_manager.py 0000644 0006212 0006212 00000003407 14172556763 016773 0 ustar 0000000 0000000 # -*- coding: utf-8 -*-
# © Copyright EnterpriseDB UK Limited 2013-2022
#
# This file is part of Barman.
#
# Barman is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Barman is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Barman. If not, see .
from abc import ABCMeta, abstractmethod
from barman.utils import with_metaclass
class FileManager(with_metaclass(ABCMeta)):
@abstractmethod
def file_exist(self, file_path):
"""
Tests if file exists
:param file_path: File path
:type file_path: string
:return: True if file exists False otherwise
:rtype: bool
"""
@abstractmethod
def get_file_stats(self, file_path):
"""
Tests if file exists
:param file_path: File path
:type file_path: string
:return:
:rtype: FileStats
"""
@abstractmethod
def get_file_list(self, path):
"""
List all files within a path, including subdirectories
:param path: Path to analyze
:type path: string
:return: List of file path
:rtype: list
"""
@abstractmethod
def get_file_content(self, file_path, file_mode="rb"):
""" """
@abstractmethod
def save_content_to_file(self, file_path, content, file_mode="wb"):
""" """
barman-2.18/barman/storage/local_file_manager.py 0000644 0006212 0006212 00000004535 14172556763 020150 0 ustar 0000000 0000000 # -*- coding: utf-8 -*-
# © Copyright EnterpriseDB UK Limited 2013-2022
#
# This file is part of Barman.
#
# Barman is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Barman is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Barman. If not, see .
import os
from .file_manager import FileManager
from .file_stats import FileStats
class LocalFileManager(FileManager):
def file_exist(self, file_path):
"""
Tests if file exists
:param file_path: File path
:type file_path: string
:return: True if file exists False otherwise
:rtype: bool
"""
return os.path.isfile(file_path)
def get_file_stats(self, file_path):
"""
Tests if file exists
:param file_path: File path
:type file_path: string
:return:
:rtype: FileStats
"""
if not self.file_exist(file_path):
raise IOError("Missing file " + file_path)
sts = os.stat(file_path)
return FileStats(sts.st_size, sts.st_mtime)
def get_file_list(self, path):
"""
List all files within a path, including subdirectories
:param path: Path to analyze
:type path: string
:return: List of file path
:rtype: list
"""
if not os.path.isdir(path):
raise NotADirectoryError(path)
file_list = []
for root, dirs, files in os.walk(path):
file_list.extend(
list(map(lambda x, prefix=root: os.path.join(prefix, x), files))
)
return file_list
def get_file_content(self, file_path, file_mode="rb"):
with open(file_path, file_mode) as reader:
content = reader.read()
return content
def save_content_to_file(self, file_path, content, file_mode="wb"):
""" """
with open(file_path, file_mode) as writer:
writer.write(content)
barman-2.18/barman/storage/file_stats.py 0000644 0006212 0006212 00000003217 14172556763 016516 0 ustar 0000000 0000000 # -*- coding: utf-8 -*-
# © Copyright EnterpriseDB UK Limited 2013-2022
#
# This file is part of Barman.
#
# Barman is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Barman is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Barman. If not, see .
from datetime import datetime
try:
from datetime import timezone
utc = timezone.utc
except ImportError:
# python 2.7 compatibility
from dateutil import tz
utc = tz.tzutc()
class FileStats:
def __init__(self, size, last_modified):
"""
Arbitrary timezone set to UTC. There is probably possible improvement here.
:param size: file size in bytes
:type size: int
:param last_modified: Time of last modification in seconds
:type last_modified: int
"""
self.size = size
self.last_modified = datetime.fromtimestamp(last_modified, tz=utc)
def get_size(self):
""" """
return self.size
def get_last_modified(self, datetime_format="%Y-%m-%d %H:%M:%S"):
"""
:param datetime_format: Format to apply on datetime object
:type datetime_format: str
"""
return self.last_modified.strftime(datetime_format)
barman-2.18/barman/retention_policies.py 0000644 0006212 0006212 00000045245 14172556763 016622 0 ustar 0000000 0000000 # -*- coding: utf-8 -*-
# © Copyright EnterpriseDB UK Limited 2011-2022
#
# This file is part of Barman.
#
# Barman is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Barman is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Barman. If not, see .
"""
This module defines backup retention policies. A backup retention
policy in Barman is a user-defined policy for determining how long
backups and archived logs (WAL segments) need to be retained for media
recovery.
You can define a retention policy in terms of backup redundancy
or a recovery window.
Barman retains the periodical backups required to satisfy
the current retention policy, and any archived WAL files required for complete
recovery of those backups.
"""
import logging
import re
from abc import ABCMeta, abstractmethod
from datetime import datetime, timedelta
from dateutil import tz
from barman.annotations import KeepManager
from barman.exceptions import InvalidRetentionPolicy
from barman.infofile import BackupInfo
from barman.utils import with_metaclass
_logger = logging.getLogger(__name__)
class RetentionPolicy(with_metaclass(ABCMeta, object)):
"""Abstract base class for retention policies"""
def __init__(self, mode, unit, value, context, server):
"""Constructor of the retention policy base class"""
self.mode = mode
self.unit = unit
self.value = int(value)
self.context = context
self.server = server
self._first_backup = None
self._first_wal = None
def report(self, source=None, context=None):
"""Report obsolete/valid objects according to the retention policy"""
if context is None:
context = self.context
# Overrides the list of available backups
if source is None:
source = self.server.available_backups
if context == "BASE":
return self._backup_report(source)
elif context == "WAL":
return self._wal_report()
else:
raise ValueError("Invalid context %s", context)
def backup_status(self, backup_id):
"""Report the status of a backup according to the retention policy"""
source = self.server.available_backups
if self.context == "BASE":
return self._backup_report(source)[backup_id]
else:
return BackupInfo.NONE
def first_backup(self):
"""Returns the first valid backup according to retention policies"""
if not self._first_backup:
self.report(context="BASE")
return self._first_backup
def first_wal(self):
"""Returns the first valid WAL according to retention policies"""
if not self._first_wal:
self.report(context="WAL")
return self._first_wal
@abstractmethod
def __str__(self):
"""String representation"""
pass
@abstractmethod
def debug(self):
"""Debug information"""
pass
@abstractmethod
def _backup_report(self, source):
"""Report obsolete/valid backups according to the retention policy"""
pass
@abstractmethod
def _wal_report(self):
"""Report obsolete/valid WALs according to the retention policy"""
pass
@classmethod
def create(cls, server, option, value):
"""
If given option and value from the configuration file match,
creates the retention policy object for the given server
"""
# using @abstractclassmethod from python3 would be better here
raise NotImplementedError(
"The class %s must override the create() class method", cls.__name__
)
def to_json(self):
"""
Output representation of the obj for JSON serialization
"""
return "%s %s %s" % (self.mode, self.value, self.unit)
class RedundancyRetentionPolicy(RetentionPolicy):
"""
Retention policy based on redundancy, the setting that determines
many periodical backups to keep. A redundancy-based retention policy
is contrasted with retention policy that uses a recovery window.
"""
_re = re.compile(r"^\s*redundancy\s+(\d+)\s*$", re.IGNORECASE)
def __init__(self, context, value, server):
super(RedundancyRetentionPolicy, self).__init__(
"redundancy", "b", value, "BASE", server
)
assert value >= 0
def __str__(self):
return "REDUNDANCY %s" % self.value
def debug(self):
return "Redundancy: %s (%s)" % (self.value, self.context)
def _backup_report(self, source):
"""Report obsolete/valid backups according to the retention policy"""
report = dict()
backups = source
# Normalise the redundancy value (according to minimum redundancy)
redundancy = self.value
if redundancy < self.server.minimum_redundancy:
_logger.warning(
"Retention policy redundancy (%s) is lower than "
"the required minimum redundancy (%s). Enforce %s.",
redundancy,
self.server.minimum_redundancy,
self.server.minimum_redundancy,
)
redundancy = self.server.minimum_redundancy
# Map the latest 'redundancy' DONE backups as VALID
# The remaining DONE backups are classified as OBSOLETE
# Non DONE backups are classified as NONE
# NOTE: reverse key orders (simulate reverse chronology)
i = 0
for bid in sorted(backups.keys(), reverse=True):
if backups[bid].status == BackupInfo.DONE:
keep_target = self.server.get_keep_target(bid)
if keep_target == KeepManager.TARGET_STANDALONE:
report[bid] = BackupInfo.KEEP_STANDALONE
elif keep_target:
# Any other recovery target is treated as KEEP_FULL for safety
report[bid] = BackupInfo.KEEP_FULL
elif i < redundancy:
report[bid] = BackupInfo.VALID
self._first_backup = bid
else:
report[bid] = BackupInfo.OBSOLETE
i = i + 1
else:
report[bid] = BackupInfo.NONE
return report
def _wal_report(self):
"""Report obsolete/valid WALs according to the retention policy"""
pass
@classmethod
def create(cls, server, context, optval):
# Detect Redundancy retention type
mtch = cls._re.match(optval)
if not mtch:
return None
value = int(mtch.groups()[0])
return cls(context, value, server)
class RecoveryWindowRetentionPolicy(RetentionPolicy):
"""
Retention policy based on recovery window. The DBA specifies a period of
time and Barman ensures retention of backups and archived WAL files
required for point-in-time recovery to any time during the recovery window.
The interval always ends with the current time and extends back in time
for the number of days specified by the user.
For example, if the retention policy is set for a recovery window of
seven days, and the current time is 9:30 AM on Friday, Barman retains
the backups required to allow point-in-time recovery back to 9:30 AM
on the previous Friday.
"""
_re = re.compile(
r"""
^\s*
recovery\s+window\s+of\s+ # recovery window of
(\d+)\s+(day|month|week)s? # N (day|month|week) with optional 's'
\s*$
""",
re.IGNORECASE | re.VERBOSE,
)
_kw = {"d": "DAYS", "m": "MONTHS", "w": "WEEKS"}
def __init__(self, context, value, unit, server):
super(RecoveryWindowRetentionPolicy, self).__init__(
"window", unit, value, context, server
)
assert value >= 0
assert unit == "d" or unit == "m" or unit == "w"
assert context == "WAL" or context == "BASE"
# Calculates the time delta
if unit == "d":
self.timedelta = timedelta(days=self.value)
elif unit == "w":
self.timedelta = timedelta(weeks=self.value)
elif unit == "m":
self.timedelta = timedelta(days=(31 * self.value))
def __str__(self):
return "RECOVERY WINDOW OF %s %s" % (self.value, self._kw[self.unit])
def debug(self):
return "Recovery Window: %s %s: %s (%s)" % (
self.value,
self.unit,
self.context,
self._point_of_recoverability(),
)
def _point_of_recoverability(self):
"""
Based on the current time and the window, calculate the point
of recoverability, which will be then used to define the first
backup or the first WAL
"""
return datetime.now(tz.tzlocal()) - self.timedelta
def _backup_report(self, source):
"""Report obsolete/valid backups according to the retention policy"""
report = dict()
backups = source
# Map as VALID all DONE backups having end time lower than
# the point of recoverability. The older ones
# are classified as OBSOLETE.
# Non DONE backups are classified as NONE
found = False
valid = 0
# NOTE: reverse key orders (simulate reverse chronology)
for bid in sorted(backups.keys(), reverse=True):
# We are interested in DONE backups only
if backups[bid].status == BackupInfo.DONE:
keep_target = self.server.get_keep_target(bid)
if keep_target == KeepManager.TARGET_STANDALONE:
keep_target = BackupInfo.KEEP_STANDALONE
elif keep_target:
# Any other recovery target is treated as KEEP_FULL for safety
keep_target = BackupInfo.KEEP_FULL
# By found, we mean "found the first backup outside the recovery
# window" if that is the case then this bid is potentially obsolete.
if found:
# Check minimum redundancy requirements
if valid < self.server.minimum_redundancy:
if keep_target:
_logger.info(
"Keeping obsolete backup %s for server %s "
"(older than %s) "
"due to keep status: %s",
bid,
self.server.name,
self._point_of_recoverability,
keep_target,
)
report[bid] = keep_target
else:
_logger.warning(
"Keeping obsolete backup %s for server %s "
"(older than %s) "
"due to minimum redundancy requirements (%s)",
bid,
self.server.name,
self._point_of_recoverability(),
self.server.minimum_redundancy,
)
# We mark the backup as potentially obsolete
# as we must respect minimum redundancy requirements
report[bid] = BackupInfo.POTENTIALLY_OBSOLETE
self._first_backup = bid
valid = valid + 1
else:
if keep_target:
_logger.info(
"Keeping obsolete backup %s for server %s "
"(older than %s) "
"due to keep status: %s",
bid,
self.server.name,
self._point_of_recoverability,
keep_target,
)
report[bid] = keep_target
else:
# We mark this backup as obsolete
# (older than the first valid one)
_logger.info(
"Reporting backup %s for server %s as OBSOLETE "
"(older than %s)",
bid,
self.server.name,
self._point_of_recoverability(),
)
report[bid] = BackupInfo.OBSOLETE
else:
_logger.debug(
"Reporting backup %s for server %s as VALID (newer than %s)",
bid,
self.server.name,
self._point_of_recoverability(),
)
# Backup within the recovery window
report[bid] = keep_target or BackupInfo.VALID
self._first_backup = bid
valid = valid + 1
# TODO: Currently we use the backup local end time
# We need to make this more accurate
if backups[bid].end_time < self._point_of_recoverability():
found = True
else:
report[bid] = BackupInfo.NONE
return report
def _wal_report(self):
"""Report obsolete/valid WALs according to the retention policy"""
pass
@classmethod
def create(cls, server, context, optval):
# Detect Recovery Window retention type
match = cls._re.match(optval)
if not match:
return None
value = int(match.groups()[0])
unit = match.groups()[1][0].lower()
return cls(context, value, unit, server)
class SimpleWALRetentionPolicy(RetentionPolicy):
"""Simple retention policy for WAL files (identical to the main one)"""
_re = re.compile(r"^\s*main\s*$", re.IGNORECASE)
def __init__(self, context, policy, server):
super(SimpleWALRetentionPolicy, self).__init__(
"simple-wal", policy.unit, policy.value, context, server
)
# The referred policy must be of type 'BASE'
assert self.context == "WAL" and policy.context == "BASE"
self.policy = policy
def __str__(self):
return "MAIN"
def debug(self):
return "Simple WAL Retention Policy (%s)" % self.policy
def _backup_report(self, source):
"""Report obsolete/valid backups according to the retention policy"""
pass
def _wal_report(self):
"""Report obsolete/valid backups according to the retention policy"""
self.policy.report(context="WAL")
def first_wal(self):
"""Returns the first valid WAL according to retention policies"""
return self.policy.first_wal()
@classmethod
def create(cls, server, context, optval):
# Detect Redundancy retention type
match = cls._re.match(optval)
if not match:
return None
return cls(context, server.retention_policy, server)
class ServerMetadata(object):
"""
Static retention metadata for a barman-managed server
This will return the same values regardless of any changes in the state of
the barman-managed server and associated backups.
"""
def __init__(self, server_name, backup_info_list, keep_manager):
self.name = server_name
self.minimum_redundancy = 0
self.retention_policy = None
self.backup_info_list = backup_info_list
self.keep_manager = keep_manager
@property
def available_backups(self):
return self.backup_info_list
def get_keep_target(self, backup_id):
return self.keep_manager.get_keep_target(backup_id)
class ServerMetadataLive(ServerMetadata):
"""
Live retention metadata for a barman-managed server
This will always return the current values for the barman.Server passed in
at construction time.
"""
def __init__(self, server, keep_manager):
self.server = server
self.keep_manager = keep_manager
@property
def name(self):
return self.server.config.name
@property
def minimum_redundancy(self):
return self.server.config.minimum_redundancy
@property
def retention_policy(self):
return self.server.config.retention_policy
@property
def available_backups(self):
return self.server.get_available_backups(BackupInfo.STATUS_NOT_EMPTY)
def get_keep_target(self, backup_id):
return self.keep_manager.get_keep_target(backup_id)
class RetentionPolicyFactory(object):
"""Factory for retention policy objects"""
# Available retention policy types
policy_classes = [
RedundancyRetentionPolicy,
RecoveryWindowRetentionPolicy,
SimpleWALRetentionPolicy,
]
@classmethod
def create(cls, option, value, server=None, server_name=None, catalog=None):
"""
Based on the given option and value from the configuration
file, creates the appropriate retention policy object
for the given server
Either server *or* server_name and backup_info_list must be provided.
If server (a `barman.Server`) is provided then the returned
RetentionPolicy will update as the state of the `barman.Server` changes.
If server_name and backup_info_list are provided then the RetentionPolicy
will be a snapshot based on the backup_info_list passed at construction
time.
"""
if option == "wal_retention_policy":
context = "WAL"
elif option == "retention_policy":
context = "BASE"
else:
raise InvalidRetentionPolicy(
"Unknown option for retention policy: %s" % option
)
if server:
server_metadata = ServerMetadataLive(
server, keep_manager=server.backup_manager
)
else:
server_metadata = ServerMetadata(
server_name, catalog.get_backup_list(), keep_manager=catalog
)
# Look for the matching rule
for policy_class in cls.policy_classes:
policy = policy_class.create(server_metadata, context, value)
if policy:
return policy
raise InvalidRetentionPolicy("Cannot parse option %s: %s" % (option, value))
barman-2.18/barman/utils.py 0000644 0006212 0006212 00000047612 14172556763 014064 0 ustar 0000000 0000000 # -*- coding: utf-8 -*-
# © Copyright EnterpriseDB UK Limited 2011-2022
#
# This file is part of Barman.
#
# Barman is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Barman is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Barman. If not, see .
"""
This module contains utility functions used in Barman.
"""
import datetime
import decimal
import errno
import grp
import hashlib
import json
import logging
import logging.handlers
import os
import pwd
import re
import signal
import sys
from argparse import ArgumentTypeError
from abc import ABCMeta, abstractmethod
from contextlib import contextmanager
from distutils.version import Version
from barman.exceptions import TimeoutError
_logger = logging.getLogger(__name__)
if sys.version_info[0] >= 3:
_text_type = str
_string_types = str
else:
_text_type = unicode # noqa
_string_types = basestring # noqa
def drop_privileges(user):
"""
Change the system user of the current python process.
It will only work if called as root or as the target user.
:param string user: target user
:raise KeyError: if the target user doesn't exists
:raise OSError: when the user change fails
"""
pw = pwd.getpwnam(user)
if pw.pw_uid == os.getuid():
return
groups = [e.gr_gid for e in grp.getgrall() if pw.pw_name in e.gr_mem]
groups.append(pw.pw_gid)
os.setgroups(groups)
os.setgid(pw.pw_gid)
os.setuid(pw.pw_uid)
os.environ["HOME"] = pw.pw_dir
def mkpath(directory):
"""
Recursively create a target directory.
If the path already exists it does nothing.
:param str directory: directory to be created
"""
if not os.path.isdir(directory):
os.makedirs(directory)
def configure_logging(
log_file,
log_level=logging.INFO,
log_format="%(asctime)s %(name)s %(levelname)s: %(message)s",
):
"""
Configure the logging module
:param str,None log_file: target file path. If None use standard error.
:param int log_level: min log level to be reported in log file.
Default to INFO
:param str log_format: format string used for a log line.
Default to "%(asctime)s %(name)s %(levelname)s: %(message)s"
"""
warn = None
handler = logging.StreamHandler()
if log_file:
log_file = os.path.abspath(log_file)
log_dir = os.path.dirname(log_file)
try:
mkpath(log_dir)
handler = logging.handlers.WatchedFileHandler(log_file, encoding="utf-8")
except (OSError, IOError):
# fallback to standard error
warn = (
"Failed opening the requested log file. "
"Using standard error instead."
)
formatter = logging.Formatter(log_format)
handler.setFormatter(formatter)
logging.root.addHandler(handler)
if warn:
# this will be always displayed because the default level is WARNING
_logger.warn(warn)
logging.root.setLevel(log_level)
def parse_log_level(log_level):
"""
Convert a log level to its int representation as required by
logging module.
:param log_level: An integer or a string
:return: an integer or None if an invalid argument is provided
"""
try:
log_level_int = int(log_level)
except ValueError:
log_level_int = logging.getLevelName(str(log_level).upper())
if isinstance(log_level_int, int):
return log_level_int
return None
# noinspection PyProtectedMember
def get_log_levels():
"""
Return a list of available log level names
"""
try:
level_to_name = logging._levelToName
except AttributeError:
level_to_name = dict(
[
(key, logging._levelNames[key])
for key in logging._levelNames
if isinstance(key, int)
]
)
for level in sorted(level_to_name):
yield level_to_name[level]
def pretty_size(size, unit=1024):
"""
This function returns a pretty representation of a size value
:param int|long|float size: the number to to prettify
:param int unit: 1000 or 1024 (the default)
:rtype: str
"""
suffixes = ["B"] + [i + {1000: "B", 1024: "iB"}[unit] for i in "KMGTPEZY"]
if unit == 1000:
suffixes[1] = "kB" # special case kB instead of KB
# cast to float to avoid losing decimals
size = float(size)
for suffix in suffixes:
if abs(size) < unit or suffix == suffixes[-1]:
if suffix == suffixes[0]:
return "%d %s" % (size, suffix)
else:
return "%.1f %s" % (size, suffix)
else:
size /= unit
def human_readable_timedelta(timedelta):
"""
Given a time interval, returns a human readable string
:param timedelta: the timedelta to transform in a human readable form
"""
delta = abs(timedelta)
# Calculate time units for the given interval
time_map = {
"day": int(delta.days),
"hour": int(delta.seconds / 3600),
"minute": int(delta.seconds / 60) % 60,
"second": int(delta.seconds % 60),
}
# Build the resulting string
time_list = []
# 'Day' part
if time_map["day"] > 0:
if time_map["day"] == 1:
time_list.append("%s day" % time_map["day"])
else:
time_list.append("%s days" % time_map["day"])
# 'Hour' part
if time_map["hour"] > 0:
if time_map["hour"] == 1:
time_list.append("%s hour" % time_map["hour"])
else:
time_list.append("%s hours" % time_map["hour"])
# 'Minute' part
if time_map["minute"] > 0:
if time_map["minute"] == 1:
time_list.append("%s minute" % time_map["minute"])
else:
time_list.append("%s minutes" % time_map["minute"])
# 'Second' part
if time_map["second"] > 0:
if time_map["second"] == 1:
time_list.append("%s second" % time_map["second"])
else:
time_list.append("%s seconds" % time_map["second"])
human = ", ".join(time_list)
# Take care of timedelta when is shorter than a second
if delta < datetime.timedelta(seconds=1):
human = "less than one second"
# If timedelta is negative append 'ago' suffix
if delta != timedelta:
human += " ago"
return human
def total_seconds(timedelta):
"""
Compatibility method because the total_seconds method has been introduced
in Python 2.7
:param timedelta: a timedelta object
:rtype: float
"""
if hasattr(timedelta, "total_seconds"):
return timedelta.total_seconds()
else:
secs = (timedelta.seconds + timedelta.days * 24 * 3600) * 10 ** 6
return (timedelta.microseconds + secs) / 10.0 ** 6
def which(executable, path=None):
"""
This method is useful to find if a executable is present into the
os PATH
:param str executable: The name of the executable to find
:param str|None path: An optional search path to override the current one.
:return str|None: the path of the executable or None
"""
# Get the system path if needed
if path is None:
path = os.getenv("PATH")
# If the path is None at this point we have nothing to search
if path is None:
return None
# If executable is an absolute path, check if it exists and is executable
# otherwise return failure.
if os.path.isabs(executable):
if os.path.exists(executable) and os.access(executable, os.X_OK):
return executable
else:
return None
# Search the requested executable in every directory present in path and
# return the first occurrence that exists and is executable.
for file_path in path.split(os.path.pathsep):
file_path = os.path.join(file_path, executable)
# If the file exists and is executable return the full path.
if os.path.exists(file_path) and os.access(file_path, os.X_OK):
return file_path
# If no matching file is present on the system return None
return None
class BarmanEncoder(json.JSONEncoder):
"""
Custom JSON encoder used for BackupInfo encoding
This encoder supports the following types:
* dates and timestamps if they have a ctime() method.
* objects that implement the 'to_json' method.
* binary strings (python 3)
"""
def default(self, obj):
# If the object implements to_json() method use it
if hasattr(obj, "to_json"):
return obj.to_json()
# Serialise date and datetime objects using ctime() method
if hasattr(obj, "ctime") and callable(obj.ctime):
return obj.ctime()
# Serialise timedelta objects using human_readable_timedelta()
if isinstance(obj, datetime.timedelta):
return human_readable_timedelta(obj)
# Serialise Decimal objects using their string representation
# WARNING: When deserialized they will be treat as float values
# which have a lower precision
if isinstance(obj, decimal.Decimal):
return float(obj)
# Binary strings must be decoded before using them in
# an unicode string
if hasattr(obj, "decode") and callable(obj.decode):
return obj.decode("utf-8", "replace")
# Manage (Loose|Strict)Version objects as strings.
if isinstance(obj, Version):
return str(obj)
# Let the base class default method raise the TypeError
return super(BarmanEncoder, self).default(obj)
def fsync_dir(dir_path):
"""
Execute fsync on a directory ensuring it is synced to disk
:param str dir_path: The directory to sync
:raise OSError: If fail opening the directory
"""
dir_fd = os.open(dir_path, os.O_DIRECTORY)
try:
os.fsync(dir_fd)
except OSError as e:
# On some filesystem doing a fsync on a directory
# raises an EINVAL error. Ignoring it is usually safe.
if e.errno != errno.EINVAL:
raise
finally:
os.close(dir_fd)
def fsync_file(file_path):
"""
Execute fsync on a file ensuring it is synced to disk
Returns the file stats
:param str file_path: The file to sync
:return: file stat
:raise OSError: If something fails
"""
file_fd = os.open(file_path, os.O_RDONLY)
file_stat = os.fstat(file_fd)
try:
os.fsync(file_fd)
return file_stat
except OSError as e:
# On some filesystem doing a fsync on a O_RDONLY fd
# raises an EACCES error. In that case we need to try again after
# reopening as O_RDWR.
if e.errno != errno.EACCES:
raise
finally:
os.close(file_fd)
file_fd = os.open(file_path, os.O_RDWR)
try:
os.fsync(file_fd)
finally:
os.close(file_fd)
return file_stat
def simplify_version(version_string):
"""
Simplify a version number by removing the patch level
:param version_string: the version number to simplify
:return str: the simplified version number
"""
if version_string is None:
return None
version = version_string.split(".")
# If a development/beta/rc version, split out the string part
unreleased = re.search(r"[^0-9.]", version[-1])
if unreleased:
last_component = version.pop()
number = last_component[: unreleased.start()]
string = last_component[unreleased.start() :]
version += [number, string]
return ".".join(version[:-1])
def with_metaclass(meta, *bases):
"""
Function from jinja2/_compat.py. License: BSD.
Create a base class with a metaclass.
:param type meta: Metaclass to add to base class
"""
# This requires a bit of explanation: the basic idea is to make a
# dummy metaclass for one level of class instantiation that replaces
# itself with the actual metaclass.
class Metaclass(type):
def __new__(mcs, name, this_bases, d):
return meta(name, bases, d)
return type.__new__(Metaclass, "temporary_class", (), {})
@contextmanager
def timeout(timeout_duration):
"""
ContextManager responsible for timing out the contained
block of code after a defined time interval.
"""
# Define the handler for the alarm signal
def handler(signum, frame):
raise TimeoutError()
# set the timeout handler
previous_handler = signal.signal(signal.SIGALRM, handler)
if previous_handler != signal.SIG_DFL and previous_handler != signal.SIG_IGN:
signal.signal(signal.SIGALRM, previous_handler)
raise AssertionError("Another timeout is already defined")
# set the timeout duration
signal.alarm(timeout_duration)
try:
# Execute the contained block of code
yield
finally:
# Reset the signal
signal.alarm(0)
signal.signal(signal.SIGALRM, signal.SIG_DFL)
def is_power_of_two(number):
"""
Check if a number is a power of two or not
"""
# Returns None if number is set to None.
if number is None:
return None
# This is a fast method to check for a power of two.
#
# A power of two has this structure: 100000 (one or more zeroes)
# This is the same number minus one: 011111 (composed by ones)
# This is the bitwise and: 000000
#
# This is true only for every power of two
return number != 0 and (number & (number - 1)) == 0
def file_md5(file_path, buffer_size=1024 * 16):
"""
Calculate the md5 checksum for the provided file path
:param str file_path: path of the file to read
:param int buffer_size: read buffer size, default 16k
:return str: Hexadecimal md5 string
"""
md5 = hashlib.md5()
with open(file_path, "rb") as file_object:
while 1:
buf = file_object.read(buffer_size)
if not buf:
break
md5.update(buf)
return md5.hexdigest()
# Might be better to use stream instead of full file content. As done in file_md5.
# Might create performance issue for large files.
class ChecksumAlgorithm(with_metaclass(ABCMeta)):
@abstractmethod
def checksum(self, value):
"""
Creates hash hexadecimal string from input byte
:param value: Value to create checksum from
:type value: byte
:return: Return the digest value as a string of hexadecimal digits.
:rtype: str
"""
def checksum_from_str(self, value, encoding="utf-8"):
"""
Creates hash hexadecimal string from input string
:param value: Value to create checksum from
:type value: str
:param encoding: The encoding in which to encode the string.
:type encoding: str
:return: Return the digest value as a string of hexadecimal digits.
:rtype: str
"""
return self.checksum(value.encode(encoding))
def get_name(self):
return self.__class__.__name__
class SHA256(ChecksumAlgorithm):
def checksum(self, value):
"""
Creates hash hexadecimal string from input byte
:param value: Value to create checksum from
:type value: byte
:return: Return the digest value as a string of hexadecimal digits.
:rtype: str
"""
sha = hashlib.sha256(value)
return sha.hexdigest()
def force_str(obj, encoding="utf-8", errors="replace"):
"""
Force any object to an unicode string.
Code inspired by Django's force_text function
"""
# Handle the common case first for performance reasons.
if issubclass(type(obj), _text_type):
return obj
try:
if issubclass(type(obj), _string_types):
obj = obj.decode(encoding, errors)
else:
if sys.version_info[0] >= 3:
if isinstance(obj, bytes):
obj = _text_type(obj, encoding, errors)
else:
obj = _text_type(obj)
elif hasattr(obj, "__unicode__"):
obj = _text_type(obj)
else:
obj = _text_type(bytes(obj), encoding, errors)
except (UnicodeDecodeError, TypeError):
if isinstance(obj, Exception):
# If we get to here, the caller has passed in an Exception
# subclass populated with non-ASCII bytestring data without a
# working unicode method. Try to handle this without raising a
# further exception by individually forcing the exception args
# to unicode.
obj = " ".join(force_str(arg, encoding, errors) for arg in obj.args)
else:
# As last resort, use a repr call to avoid any exception
obj = repr(obj)
return obj
def redact_passwords(text):
"""
Redact passwords from the input text.
Password are found in these two forms:
Keyword/Value Connection Strings:
- host=localhost port=5432 dbname=mydb password=SHAME_ON_ME
Connection URIs:
- postgresql://[user[:password]][netloc][:port][/dbname]
:param str text: Input content
:return: String with passwords removed
"""
# Remove passwords as found in key/value connection strings
text = re.sub("password=('(\\'|[^'])+'|[^ '\"]*)", "password=*REDACTED*", text)
# Remove passwords in connection URLs
text = re.sub(r"(?<=postgresql:\/\/)([^ :@]+:)([^ :@]+)?@", r"\1*REDACTED*@", text)
return text
def check_non_negative(value):
"""
Check for a positive integer option
:param value: str containing the value to check
"""
if value is None:
return None
try:
int_value = int(value)
except Exception:
raise ArgumentTypeError("'%s' is not a valid non negative integer" % value)
if int_value < 0:
raise ArgumentTypeError("'%s' is not a valid non negative integer" % value)
return int_value
def check_positive(value):
"""
Check for a positive integer option
:param value: str containing the value to check
"""
if value is None:
return None
try:
int_value = int(value)
except Exception:
raise ArgumentTypeError("'%s' is not a valid positive integer" % value)
if int_value < 1:
raise ArgumentTypeError("'%s' is not a valid positive integer" % value)
return int_value
def check_size(value):
"""
Check user input for a human readable size
:param value: str containing the value to check
"""
if value is None:
return None
# Ignore cases
value = value.upper()
try:
# If value ends with `B` we try to parse the multiplier,
# otherwise it is a plain integer
if value[-1] == "B":
# By default we use base=1024, if the value ends with `iB`
# it is a SI value and we use base=1000
if value[-2] == "I":
base = 1000
idx = 3
else:
base = 1024
idx = 2
multiplier = base
# Parse the multiplicative prefix
for prefix in "KMGTPEZY":
if value[-idx] == prefix:
int_value = int(float(value[:-idx]) * multiplier)
break
multiplier *= base
else:
# If we do not find the prefix, remove the unit
# and try to parse the remainder as an integer
# (e.g. '1234B')
int_value = int(value[: -idx + 1])
else:
int_value = int(value)
except ValueError:
raise ArgumentTypeError("'%s' is not a valid size string" % value)
if int_value is None or int_value < 1:
raise ArgumentTypeError("'%s' is not a valid size string" % value)
return int_value
barman-2.18/barman/lockfile.py 0000644 0006212 0006212 00000026156 14172556763 014514 0 ustar 0000000 0000000 # -*- coding: utf-8 -*-
# © Copyright EnterpriseDB UK Limited 2011-2022
#
# This file is part of Barman.
#
# Barman is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Barman is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Barman. If not, see .
"""
This module is the lock manager for Barman
"""
import errno
import fcntl
import os
import re
from barman.exceptions import (
LockFileBusy,
LockFileParsingError,
LockFilePermissionDenied,
)
class LockFile(object):
"""
Ensures that there is only one process which is running against a
specified LockFile.
It supports the Context Manager interface, allowing the use in with
statements.
with LockFile('file.lock') as locked:
if not locked:
print "failed"
else:
You can also use exceptions on failures
try:
with LockFile('file.lock', True):
except LockFileBusy, e, file:
print "failed to lock %s" % file
"""
LOCK_PATTERN = None
r"""
If defined in a subclass, it must be a compiled regular expression
which matches the lock filename.
It must provide named groups for the constructor parameters which produce
the same lock name. I.e.:
>>> ServerWalReceiveLock('/tmp', 'server-name').filename
'/tmp/.server-name-receive-wal.lock'
>>> ServerWalReceiveLock.LOCK_PATTERN = re.compile(
r'\.(?P.+)-receive-wal\.lock')
>>> m = ServerWalReceiveLock.LOCK_PATTERN.match(
'.server-name-receive-wal.lock')
>>> ServerWalReceiveLock('/tmp', **(m.groupdict())).filename
'/tmp/.server-name-receive-wal.lock'
"""
@classmethod
def build_if_matches(cls, path):
"""
Factory method that creates a lock instance if the path matches
the lock filename created by the actual class
:param path: the full path of a LockFile
:return:
"""
# If LOCK_PATTERN is not defined always return None
if not cls.LOCK_PATTERN:
return None
# Matches the provided path against LOCK_PATTERN
lock_directory = os.path.abspath(os.path.dirname(path))
lock_name = os.path.basename(path)
match = cls.LOCK_PATTERN.match(lock_name)
if match:
# Build the lock object for the provided path
return cls(lock_directory, **(match.groupdict()))
return None
def __init__(self, filename, raise_if_fail=True, wait=False):
self.filename = os.path.abspath(filename)
self.fd = None
self.raise_if_fail = raise_if_fail
self.wait = wait
def acquire(self, raise_if_fail=None, wait=None, update_pid=True):
"""
Creates and holds on to the lock file.
When raise_if_fail, a LockFileBusy is raised if
the lock is held by someone else and a LockFilePermissionDenied is
raised when the user executing barman have insufficient rights for
the creation of a LockFile.
Returns True if lock has been successfully acquired, False otherwise.
:param bool raise_if_fail: If True raise an exception on failure
:param bool wait: If True issue a blocking request
:param bool update_pid: Whether to write our pid in the lockfile
:returns bool: whether the lock has been acquired
"""
if self.fd:
return True
fd = None
# method arguments take precedence on class parameters
raise_if_fail = (
raise_if_fail if raise_if_fail is not None else self.raise_if_fail
)
wait = wait if wait is not None else self.wait
try:
# 384 is 0600 in octal, 'rw-------'
fd = os.open(self.filename, os.O_CREAT | os.O_RDWR, 384)
flags = fcntl.LOCK_EX
if not wait:
flags |= fcntl.LOCK_NB
fcntl.flock(fd, flags)
if update_pid:
# Once locked, replace the content of the file
os.lseek(fd, 0, os.SEEK_SET)
os.write(fd, ("%s\n" % os.getpid()).encode("ascii"))
# Truncate the file at the current position
os.ftruncate(fd, os.lseek(fd, 0, os.SEEK_CUR))
self.fd = fd
return True
except (OSError, IOError) as e:
if fd:
os.close(fd) # let's not leak file descriptors
if raise_if_fail:
if e.errno in (errno.EAGAIN, errno.EWOULDBLOCK):
raise LockFileBusy(self.filename)
elif e.errno == errno.EACCES:
raise LockFilePermissionDenied(self.filename)
else:
raise
else:
return False
def release(self):
"""
Releases the lock.
If the lock is not held by the current process it does nothing.
"""
if not self.fd:
return
try:
fcntl.flock(self.fd, fcntl.LOCK_UN)
os.close(self.fd)
except (OSError, IOError):
pass
self.fd = None
def __del__(self):
"""
Avoid stale lock files.
"""
self.release()
# Contextmanager interface
def __enter__(self):
return self.acquire()
def __exit__(self, exception_type, value, traceback):
self.release()
def get_owner_pid(self):
"""
Test whether a lock is already held by a process.
Returns the PID of the owner process or None if the lock is available.
:rtype: int|None
:raises LockFileParsingError: when the lock content is garbled
:raises LockFilePermissionDenied: when the lockfile is not accessible
"""
try:
self.acquire(raise_if_fail=True, wait=False, update_pid=False)
except LockFileBusy:
try:
# Read the lock content and parse the PID
# NOTE: We cannot read it in the self.acquire method to avoid
# reading the previous locker PID
with open(self.filename, "r") as file_object:
return int(file_object.readline().strip())
except ValueError as e:
# This should not happen
raise LockFileParsingError(e)
# release the lock and return None
self.release()
return None
class GlobalCronLock(LockFile):
"""
This lock protects cron from multiple executions.
Creates a global '.cron.lock' lock file under the given lock_directory.
"""
def __init__(self, lock_directory):
super(GlobalCronLock, self).__init__(
os.path.join(lock_directory, ".cron.lock"), raise_if_fail=True
)
class ServerBackupLock(LockFile):
"""
This lock protects a server from multiple executions of backup command
Creates a '.-backup.lock' lock file under the given lock_directory
for the named SERVER.
"""
def __init__(self, lock_directory, server_name):
super(ServerBackupLock, self).__init__(
os.path.join(lock_directory, ".%s-backup.lock" % server_name),
raise_if_fail=True,
)
class ServerCronLock(LockFile):
"""
This lock protects a server from multiple executions of cron command
Creates a '.-cron.lock' lock file under the given lock_directory
for the named SERVER.
"""
def __init__(self, lock_directory, server_name):
super(ServerCronLock, self).__init__(
os.path.join(lock_directory, ".%s-cron.lock" % server_name),
raise_if_fail=True,
wait=False,
)
class ServerXLOGDBLock(LockFile):
"""
This lock protects a server's xlogdb access
Creates a '.-xlogdb.lock' lock file under the given lock_directory
for the named SERVER.
"""
def __init__(self, lock_directory, server_name):
super(ServerXLOGDBLock, self).__init__(
os.path.join(lock_directory, ".%s-xlogdb.lock" % server_name),
raise_if_fail=True,
wait=True,
)
class ServerWalArchiveLock(LockFile):
"""
This lock protects a server from multiple executions of wal-archive command
Creates a '.-archive-wal.lock' lock file under
the given lock_directory for the named SERVER.
"""
def __init__(self, lock_directory, server_name):
super(ServerWalArchiveLock, self).__init__(
os.path.join(lock_directory, ".%s-archive-wal.lock" % server_name),
raise_if_fail=True,
wait=False,
)
class ServerWalReceiveLock(LockFile):
"""
This lock protects a server from multiple executions of receive-wal command
Creates a '.-receive-wal.lock' lock file under
the given lock_directory for the named SERVER.
"""
# TODO: Implement on the other LockFile subclasses
LOCK_PATTERN = re.compile(r"\.(?P.+)-receive-wal\.lock")
def __init__(self, lock_directory, server_name):
super(ServerWalReceiveLock, self).__init__(
os.path.join(lock_directory, ".%s-receive-wal.lock" % server_name),
raise_if_fail=True,
wait=False,
)
class ServerBackupIdLock(LockFile):
"""
This lock protects from changing a backup that is in use.
Creates a '.-.lock' lock file under the given
lock_directory for a BACKUP of a SERVER.
"""
def __init__(self, lock_directory, server_name, backup_id):
super(ServerBackupIdLock, self).__init__(
os.path.join(lock_directory, ".%s-%s.lock" % (server_name, backup_id)),
raise_if_fail=True,
wait=False,
)
class ServerBackupSyncLock(LockFile):
"""
This lock protects from multiple executions of the sync command on the same
backup.
Creates a '.--sync-backup.lock' lock file under the given
lock_directory for a BACKUP of a SERVER.
"""
def __init__(self, lock_directory, server_name, backup_id):
super(ServerBackupSyncLock, self).__init__(
os.path.join(
lock_directory, ".%s-%s-sync-backup.lock" % (server_name, backup_id)
),
raise_if_fail=True,
wait=False,
)
class ServerWalSyncLock(LockFile):
"""
This lock protects from multiple executions of the sync-wal command
Creates a '.-sync-wal.lock' lock file under the given
lock_directory for the named SERVER.
"""
def __init__(self, lock_directory, server_name):
super(ServerWalSyncLock, self).__init__(
os.path.join(lock_directory, ".%s-sync-wal.lock" % server_name),
raise_if_fail=True,
wait=True,
)
barman-2.18/barman/process.py 0000644 0006212 0006212 00000013513 14172556763 014373 0 ustar 0000000 0000000 # -*- coding: utf-8 -*-
# © Copyright EnterpriseDB UK Limited 2011-2022
#
# This file is part of Barman.
#
# Barman is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Barman is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Barman. If not, see
import errno
import logging
import os
import signal
import time
from glob import glob
from barman import output
from barman.exceptions import LockFileParsingError
from barman.lockfile import ServerWalReceiveLock
_logger = logging.getLogger(__name__)
class ProcessInfo(object):
"""
Barman process representation
"""
def __init__(self, pid, server_name, task):
"""
This object contains all the information required to identify a
barman process
:param int pid: Process ID
:param string server_name: Name of the server owning the process
:param string task: Task name (receive-wal, archive-wal...)
"""
self.pid = pid
self.server_name = server_name
self.task = task
class ProcessManager(object):
"""
Class for the management of barman processes owned by a server
"""
# Map containing the tasks we want to retrieve (and eventually manage)
TASKS = {"receive-wal": ServerWalReceiveLock}
def __init__(self, config):
"""
Build a ProcessManager for the provided server
:param config: configuration of the server owning the process manager
"""
self.config = config
self.process_list = []
# Cycle over the lock files in the lock directory for this server
for path in glob(
os.path.join(
self.config.barman_lock_directory, ".%s-*.lock" % self.config.name
)
):
for task, lock_class in self.TASKS.items():
# Check the lock_name against the lock class
lock = lock_class.build_if_matches(path)
if lock:
try:
# Use the lock to get the owner pid
pid = lock.get_owner_pid()
except LockFileParsingError:
_logger.warning(
"Skipping the %s process for server %s: "
"Error reading the PID from lock file '%s'",
task,
self.config.name,
path,
)
break
# If there is a pid save it in the process list
if pid:
self.process_list.append(ProcessInfo(pid, config.name, task))
# In any case, we found a match, so we must stop iterating
# over the task types and handle the the next path
break
def list(self, task_filter=None):
"""
Returns a list of processes owned by this server
If no filter is provided, all the processes are returned.
:param str task_filter: Type of process we want to retrieve
:return list[ProcessInfo]: List of processes for the server
"""
server_tasks = []
for process in self.process_list:
# Filter the processes if necessary
if task_filter and process.task != task_filter:
continue
server_tasks.append(process)
return server_tasks
def kill(self, process_info, retries=10):
"""
Kill a process
Returns True if killed successfully False otherwise
:param ProcessInfo process_info: representation of the process
we want to kill
:param int retries: number of times the method will check
if the process is still alive
:rtype: bool
"""
# Try to kill the process
try:
_logger.debug("Sending SIGINT to PID %s", process_info.pid)
os.kill(process_info.pid, signal.SIGINT)
_logger.debug("os.kill call succeeded")
except OSError as e:
_logger.debug("os.kill call failed: %s", e)
# The process doesn't exists. It has probably just terminated.
if e.errno == errno.ESRCH:
return True
# Something unexpected has happened
output.error("%s", e)
return False
# Check if the process have been killed. the fastest (and maybe safest)
# way is to send a kill with 0 as signal.
# If the method returns an OSError exceptions, the process have been
# killed successfully, otherwise is still alive.
for counter in range(retries):
try:
_logger.debug(
"Checking with SIG_DFL if PID %s is still alive", process_info.pid
)
os.kill(process_info.pid, signal.SIG_DFL)
_logger.debug("os.kill call succeeded")
except OSError as e:
_logger.debug("os.kill call failed: %s", e)
# If the process doesn't exists, we are done.
if e.errno == errno.ESRCH:
return True
# Something unexpected has happened
output.error("%s", e)
return False
time.sleep(1)
_logger.debug(
"The PID %s has not been terminated after %s retries",
process_info.pid,
retries,
)
return False
barman-2.18/barman/server.py 0000644 0006212 0006212 00000470677 14172556763 014245 0 ustar 0000000 0000000 # -*- coding: utf-8 -*-
# © Copyright EnterpriseDB UK Limited 2011-2022
#
# This file is part of Barman.
#
# Barman is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Barman is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Barman. If not, see .
"""
This module represents a Server.
Barman is able to manage multiple servers.
"""
import datetime
import errno
import json
import logging
import os
import re
import shutil
import sys
import tarfile
import time
from collections import namedtuple
from contextlib import closing, contextmanager
from glob import glob
from tempfile import NamedTemporaryFile
import dateutil.tz
import barman
from barman import output, xlog
from barman.backup import BackupManager
from barman.command_wrappers import BarmanSubProcess, Command, Rsync
from barman.copy_controller import RsyncCopyController
from barman.exceptions import (
ArchiverFailure,
BadXlogSegmentName,
CommandFailedException,
ConninfoException,
InvalidRetentionPolicy,
LockFileBusy,
LockFileException,
LockFilePermissionDenied,
PostgresDuplicateReplicationSlot,
PostgresException,
PostgresInvalidReplicationSlot,
PostgresIsInRecovery,
PostgresReplicationSlotInUse,
PostgresReplicationSlotsFull,
PostgresSuperuserRequired,
PostgresUnsupportedFeature,
SyncError,
SyncNothingToDo,
SyncToBeDeleted,
TimeoutError,
UnknownBackupIdException,
)
from barman.infofile import BackupInfo, LocalBackupInfo, WalFileInfo
from barman.lockfile import (
ServerBackupIdLock,
ServerBackupLock,
ServerBackupSyncLock,
ServerCronLock,
ServerWalArchiveLock,
ServerWalReceiveLock,
ServerWalSyncLock,
ServerXLOGDBLock,
)
from barman.postgres import PostgreSQLConnection, StreamingConnection
from barman.process import ProcessManager
from barman.remote_status import RemoteStatusMixin
from barman.retention_policies import RetentionPolicyFactory, RetentionPolicy
from barman.utils import (
BarmanEncoder,
file_md5,
force_str,
fsync_dir,
fsync_file,
human_readable_timedelta,
is_power_of_two,
mkpath,
pretty_size,
timeout,
)
from barman.wal_archiver import FileWalArchiver, StreamingWalArchiver, WalArchiver
PARTIAL_EXTENSION = ".partial"
PRIMARY_INFO_FILE = "primary.info"
SYNC_WALS_INFO_FILE = "sync-wals.info"
_logger = logging.getLogger(__name__)
# NamedTuple for a better readability of SyncWalInfo
SyncWalInfo = namedtuple("SyncWalInfo", "last_wal last_position")
class CheckStrategy(object):
"""
This strategy for the 'check' collects the results of
every check and does not print any message.
This basic class is also responsible for immediately
logging any performed check with an error in case of
check failure and a debug message in case of success.
"""
# create a namedtuple object called CheckResult to manage check results
CheckResult = namedtuple("CheckResult", "server_name check status")
# Default list used as a filter to identify non-critical checks
NON_CRITICAL_CHECKS = [
"minimum redundancy requirements",
"backup maximum age",
"backup minimum size",
"failed backups",
"archiver errors",
"empty incoming directory",
"empty streaming directory",
"incoming WALs directory",
"streaming WALs directory",
"wal maximum age",
]
def __init__(self, ignore_checks=NON_CRITICAL_CHECKS):
"""
Silent Strategy constructor
:param list ignore_checks: list of checks that can be ignored
"""
self.ignore_list = ignore_checks
self.check_result = []
self.has_error = False
self.running_check = None
def init_check(self, check_name):
"""
Mark in the debug log when barman starts the execution of a check
:param str check_name: the name of the check that is starting
"""
self.running_check = check_name
_logger.debug("Starting check: '%s'" % check_name)
def _check_name(self, check):
if not check:
check = self.running_check
assert check
return check
def result(self, server_name, status, hint=None, check=None, perfdata=None):
"""
Store the result of a check (with no output).
Log any check result (error or debug level).
:param str server_name: the server is being checked
:param bool status: True if succeeded
:param str,None hint: hint to print if not None:
:param str,None check: the check name
:param str,None perfdata: additional performance data to print if not None
"""
check = self._check_name(check)
if not status:
# If the name of the check is not in the filter list,
# treat it as a blocking error, then notify the error
# and change the status of the strategy
if check not in self.ignore_list:
self.has_error = True
_logger.error(
"Check '%s' failed for server '%s'" % (check, server_name)
)
else:
# otherwise simply log the error (as info)
_logger.info(
"Ignoring failed check '%s' for server '%s'" % (check, server_name)
)
else:
_logger.debug("Check '%s' succeeded for server '%s'" % (check, server_name))
# Store the result and does not output anything
result = self.CheckResult(server_name, check, status)
self.check_result.append(result)
self.running_check = None
class CheckOutputStrategy(CheckStrategy):
"""
This strategy for the 'check' command immediately sends
the result of a check to the designated output channel.
This class derives from the basic CheckStrategy, reuses
the same logic and adds output messages.
"""
def __init__(self):
"""
Output Strategy constructor
"""
super(CheckOutputStrategy, self).__init__(ignore_checks=())
def result(self, server_name, status, hint=None, check=None, perfdata=None):
"""
Store the result of a check.
Log any check result (error or debug level).
Output the result to the user
:param str server_name: the server being checked
:param str check: the check name
:param bool status: True if succeeded
:param str,None hint: hint to print if not None:
:param str,None perfdata: additional performance data to print if not None
"""
check = self._check_name(check)
super(CheckOutputStrategy, self).result(
server_name, status, hint, check, perfdata
)
# Send result to output
output.result("check", server_name, check, status, hint, perfdata)
class Server(RemoteStatusMixin):
"""
This class represents the PostgreSQL server to backup.
"""
XLOG_DB = "xlog.db"
# the strategy for the management of the results of the various checks
__default_check_strategy = CheckOutputStrategy()
def __init__(self, config):
"""
Server constructor.
:param barman.config.ServerConfig config: the server configuration
"""
super(Server, self).__init__()
self.config = config
self.path = self._build_path(self.config.path_prefix)
self.process_manager = ProcessManager(self.config)
# If 'primary_ssh_command' is specified, the source of the backup
# for this server is a Barman installation (not a Postgres server)
self.passive_node = config.primary_ssh_command is not None
self.enforce_retention_policies = False
self.postgres = None
self.streaming = None
self.archivers = []
# Postgres configuration is available only if node is not passive
if not self.passive_node:
# Initialize the main PostgreSQL connection
try:
# Check that 'conninfo' option is properly set
if config.conninfo is None:
raise ConninfoException(
"Missing 'conninfo' parameter for server '%s'" % config.name
)
self.postgres = PostgreSQLConnection(
config.conninfo, config.immediate_checkpoint, config.slot_name
)
# If the PostgreSQLConnection creation fails, disable the Server
except ConninfoException as e:
self.config.disabled = True
self.config.msg_list.append(
"PostgreSQL connection: " + force_str(e).strip()
)
# Initialize the streaming PostgreSQL connection only when
# backup_method is postgres or the streaming_archiver is in use
if config.backup_method == "postgres" or config.streaming_archiver:
try:
if config.streaming_conninfo is None:
raise ConninfoException(
"Missing 'streaming_conninfo' parameter for "
"server '%s'" % config.name
)
self.streaming = StreamingConnection(config.streaming_conninfo)
# If the StreamingConnection creation fails, disable the server
except ConninfoException as e:
self.config.disabled = True
self.config.msg_list.append(
"Streaming connection: " + force_str(e).strip()
)
# Initialize the backup manager
self.backup_manager = BackupManager(self)
if not self.passive_node:
# Initialize the StreamingWalArchiver
# WARNING: Order of items in self.archivers list is important!
# The files will be archived in that order.
if self.config.streaming_archiver:
try:
self.archivers.append(StreamingWalArchiver(self.backup_manager))
# If the StreamingWalArchiver creation fails,
# disable the server
except AttributeError as e:
_logger.debug(e)
self.config.disabled = True
self.config.msg_list.append(
"Unable to initialise the streaming archiver"
)
# IMPORTANT: The following lines of code have been
# temporarily commented in order to make the code
# back-compatible after the introduction of 'archiver=off'
# as default value in Barman 2.0.
# When the back compatibility feature for archiver will be
# removed, the following lines need to be decommented.
# ARCHIVER_OFF_BACKCOMPATIBILITY - START OF CODE
# # At least one of the available archive modes should be enabled
# if len(self.archivers) < 1:
# self.config.disabled = True
# self.config.msg_list.append(
# "No archiver enabled for server '%s'. "
# "Please turn on 'archiver', 'streaming_archiver' or both"
# % config.name)
# ARCHIVER_OFF_BACKCOMPATIBILITY - END OF CODE
# Sanity check: if file based archiver is disabled, and only
# WAL streaming is enabled, a replication slot name must be
# configured.
if (
not self.config.archiver
and self.config.streaming_archiver
and self.config.slot_name is None
):
self.config.disabled = True
self.config.msg_list.append(
"Streaming-only archiver requires 'streaming_conninfo' "
"and 'slot_name' options to be properly configured"
)
# ARCHIVER_OFF_BACKCOMPATIBILITY - START OF CODE
# IMPORTANT: This is a back-compatibility feature that has
# been added in Barman 2.0. It highlights a deprecated
# behaviour, and helps users during this transition phase.
# It forces 'archiver=on' when both archiver and streaming_archiver
# are set to 'off' (default values) and displays a warning,
# requesting users to explicitly set the value in the
# configuration.
# When this back-compatibility feature will be removed from Barman
# (in a couple of major releases), developers will need to remove
# this block completely and reinstate the block of code you find
# a few lines below (search for ARCHIVER_OFF_BACKCOMPATIBILITY
# throughout the code).
if (
self.config.archiver is False
and self.config.streaming_archiver is False
):
output.warning(
"No archiver enabled for server '%s'. "
"Please turn on 'archiver', "
"'streaming_archiver' or both",
self.config.name,
)
output.warning("Forcing 'archiver = on'")
self.config.archiver = True
# ARCHIVER_OFF_BACKCOMPATIBILITY - END OF CODE
# Initialize the FileWalArchiver
# WARNING: Order of items in self.archivers list is important!
# The files will be archived in that order.
if self.config.archiver:
try:
self.archivers.append(FileWalArchiver(self.backup_manager))
except AttributeError as e:
_logger.debug(e)
self.config.disabled = True
self.config.msg_list.append(
"Unable to initialise the file based archiver"
)
# Set bandwidth_limit
if self.config.bandwidth_limit:
try:
self.config.bandwidth_limit = int(self.config.bandwidth_limit)
except ValueError:
_logger.warning(
'Invalid bandwidth_limit "%s" for server "%s" '
'(fallback to "0")'
% (self.config.bandwidth_limit, self.config.name)
)
self.config.bandwidth_limit = None
# set tablespace_bandwidth_limit
if self.config.tablespace_bandwidth_limit:
rules = {}
for rule in self.config.tablespace_bandwidth_limit.split():
try:
key, value = rule.split(":", 1)
value = int(value)
if value != self.config.bandwidth_limit:
rules[key] = value
except ValueError:
_logger.warning(
"Invalid tablespace_bandwidth_limit rule '%s'" % rule
)
if len(rules) > 0:
self.config.tablespace_bandwidth_limit = rules
else:
self.config.tablespace_bandwidth_limit = None
# Set minimum redundancy (default 0)
try:
self.config.minimum_redundancy = int(self.config.minimum_redundancy)
if self.config.minimum_redundancy < 0:
_logger.warning(
'Negative value of minimum_redundancy "%s" '
'for server "%s" (fallback to "0")'
% (self.config.minimum_redundancy, self.config.name)
)
self.config.minimum_redundancy = 0
except ValueError:
_logger.warning(
'Invalid minimum_redundancy "%s" for server "%s" '
'(fallback to "0")' % (self.config.minimum_redundancy, self.config.name)
)
self.config.minimum_redundancy = 0
# Initialise retention policies
self._init_retention_policies()
def _init_retention_policies(self):
# Set retention policy mode
if self.config.retention_policy_mode != "auto":
_logger.warning(
'Unsupported retention_policy_mode "%s" for server "%s" '
'(fallback to "auto")'
% (self.config.retention_policy_mode, self.config.name)
)
self.config.retention_policy_mode = "auto"
# If retention_policy is present, enforce them
if self.config.retention_policy and not isinstance(
self.config.retention_policy, RetentionPolicy
):
# Check wal_retention_policy
if self.config.wal_retention_policy != "main":
_logger.warning(
'Unsupported wal_retention_policy value "%s" '
'for server "%s" (fallback to "main")'
% (self.config.wal_retention_policy, self.config.name)
)
self.config.wal_retention_policy = "main"
# Create retention policy objects
try:
rp = RetentionPolicyFactory.create(
"retention_policy", self.config.retention_policy, server=self
)
# Reassign the configuration value (we keep it in one place)
self.config.retention_policy = rp
_logger.debug(
"Retention policy for server %s: %s"
% (self.config.name, self.config.retention_policy)
)
try:
rp = RetentionPolicyFactory.create(
"wal_retention_policy",
self.config.wal_retention_policy,
server=self,
)
# Reassign the configuration value
# (we keep it in one place)
self.config.wal_retention_policy = rp
_logger.debug(
"WAL retention policy for server %s: %s"
% (self.config.name, self.config.wal_retention_policy)
)
except InvalidRetentionPolicy:
_logger.exception(
'Invalid wal_retention_policy setting "%s" '
'for server "%s" (fallback to "main")'
% (self.config.wal_retention_policy, self.config.name)
)
rp = RetentionPolicyFactory.create(
"wal_retention_policy", "main", server=self
)
self.config.wal_retention_policy = rp
self.enforce_retention_policies = True
except InvalidRetentionPolicy:
_logger.exception(
'Invalid retention_policy setting "%s" for server "%s"'
% (self.config.retention_policy, self.config.name)
)
def get_identity_file_path(self):
"""
Get the path of the file that should contain the identity
of the cluster
:rtype: str
"""
return os.path.join(self.config.backup_directory, "identity.json")
def write_identity_file(self):
"""
Store the identity of the server if it doesn't already exist.
"""
file_path = self.get_identity_file_path()
# Do not write the identity if file already exists
if os.path.exists(file_path):
return
systemid = self.systemid
if systemid:
try:
with open(file_path, "w") as fp:
json.dump(
{
"systemid": systemid,
"version": self.postgres.server_major_version,
},
fp,
indent=4,
sort_keys=True,
)
fp.write("\n")
except IOError:
_logger.exception(
'Cannot write system Id file for server "%s"' % (self.config.name)
)
def read_identity_file(self):
"""
Read the server identity
:rtype: dict[str,str]
"""
file_path = self.get_identity_file_path()
try:
with open(file_path, "r") as fp:
return json.load(fp)
except IOError:
_logger.exception(
'Cannot read system Id file for server "%s"' % (self.config.name)
)
return {}
def close(self):
"""
Close all the open connections to PostgreSQL
"""
if self.postgres:
self.postgres.close()
if self.streaming:
self.streaming.close()
def check(self, check_strategy=__default_check_strategy):
"""
Implements the 'server check' command and makes sure SSH and PostgreSQL
connections work properly. It checks also that backup directories exist
(and if not, it creates them).
The check command will time out after a time interval defined by the
check_timeout configuration value (default 30 seconds)
:param CheckStrategy check_strategy: the strategy for the management
of the results of the various checks
"""
try:
with timeout(self.config.check_timeout):
# Check WAL archive
self.check_archive(check_strategy)
# Postgres configuration is not available on passive nodes
if not self.passive_node:
self.check_postgres(check_strategy)
# Check barman directories from barman configuration
self.check_directories(check_strategy)
# Check retention policies
self.check_retention_policy_settings(check_strategy)
# Check for backup validity
self.check_backup_validity(check_strategy)
# Check WAL archiving is happening
self.check_wal_validity(check_strategy)
# Executes the backup manager set of checks
self.backup_manager.check(check_strategy)
# Check if the msg_list of the server
# contains messages and output eventual failures
self.check_configuration(check_strategy)
# Check the system Id coherence between
# streaming and normal connections
self.check_identity(check_strategy)
# Executes check() for every archiver, passing
# remote status information for efficiency
for archiver in self.archivers:
archiver.check(check_strategy)
# Check archiver errors
self.check_archiver_errors(check_strategy)
except TimeoutError:
# The check timed out.
# Add a failed entry to the check strategy for this.
_logger.debug(
"Check command timed out executing '%s' check"
% check_strategy.running_check
)
check_strategy.result(
self.config.name,
False,
hint="barman check command timed out",
check="check timeout",
)
def check_archive(self, check_strategy):
"""
Checks WAL archive
:param CheckStrategy check_strategy: the strategy for the management
of the results of the various checks
"""
check_strategy.init_check("WAL archive")
# Make sure that WAL archiving has been setup
# XLOG_DB needs to exist and its size must be > 0
# NOTE: we do not need to acquire a lock in this phase
xlogdb_empty = True
if os.path.exists(self.xlogdb_file_name):
with open(self.xlogdb_file_name, "rb") as fxlogdb:
if os.fstat(fxlogdb.fileno()).st_size > 0:
xlogdb_empty = False
# NOTE: This check needs to be only visible if it fails
if xlogdb_empty:
# Skip the error if we have a terminated backup
# with status WAITING_FOR_WALS.
# TODO: Improve this check
backup_id = self.get_last_backup_id([BackupInfo.WAITING_FOR_WALS])
if not backup_id:
check_strategy.result(
self.config.name,
False,
hint="please make sure WAL shipping is setup",
)
# Check the number of wals in the incoming directory
self._check_wal_queue(check_strategy, "incoming", "archiver")
# Check the number of wals in the streaming directory
self._check_wal_queue(check_strategy, "streaming", "streaming_archiver")
def _check_wal_queue(self, check_strategy, dir_name, archiver_name):
"""
Check if one of the wal queue directories beyond the
max file threshold
"""
# Read the wal queue location from the configuration
config_name = "%s_wals_directory" % dir_name
assert hasattr(self.config, config_name)
incoming_dir = getattr(self.config, config_name)
# Check if the archiver is enabled
assert hasattr(self.config, archiver_name)
enabled = getattr(self.config, archiver_name)
# Inspect the wal queue directory
file_count = 0
for file_item in glob(os.path.join(incoming_dir, "*")):
# Ignore temporary files
if file_item.endswith(".tmp"):
continue
file_count += 1
max_incoming_wal = self.config.max_incoming_wals_queue
# Subtract one from the count because of .partial file inside the
# streaming directory
if dir_name == "streaming":
file_count -= 1
# If this archiver is disabled, check the number of files in the
# corresponding directory.
# If the directory is NOT empty, fail the check and warn the user.
# NOTE: This check is visible only when it fails
check_strategy.init_check("empty %s directory" % dir_name)
if not enabled:
if file_count > 0:
check_strategy.result(
self.config.name,
False,
hint="'%s' must be empty when %s=off"
% (incoming_dir, archiver_name),
)
# No more checks are required if the archiver
# is not enabled
return
# At this point if max_wals_count is none,
# means that no limit is set so we just need to return
if max_incoming_wal is None:
return
check_strategy.init_check("%s WALs directory" % dir_name)
if file_count > max_incoming_wal:
msg = "there are too many WALs in queue: %s, max %s" % (
file_count,
max_incoming_wal,
)
check_strategy.result(self.config.name, False, hint=msg)
def check_postgres(self, check_strategy):
"""
Checks PostgreSQL connection
:param CheckStrategy check_strategy: the strategy for the management
of the results of the various checks
"""
check_strategy.init_check("PostgreSQL")
# Take the status of the remote server
remote_status = self.get_remote_status()
if remote_status.get("server_txt_version"):
check_strategy.result(self.config.name, True)
else:
check_strategy.result(self.config.name, False)
return
# Check for superuser privileges or
# privileges needed to perform backups
if remote_status.get("has_backup_privileges") is not None:
check_strategy.init_check(
"superuser or standard user with backup privileges"
)
if remote_status.get("has_backup_privileges"):
check_strategy.result(self.config.name, True)
else:
check_strategy.result(
self.config.name,
False,
hint="privileges for PostgreSQL backup functions are "
"required (see documentation)",
check="no access to backup functions",
)
if "streaming_supported" in remote_status:
check_strategy.init_check("PostgreSQL streaming")
hint = None
# If a streaming connection is available,
# add its status to the output of the check
if remote_status["streaming_supported"] is None:
hint = remote_status["connection_error"]
elif not remote_status["streaming_supported"]:
hint = "Streaming connection not supported for PostgreSQL < 9.2"
check_strategy.result(
self.config.name, remote_status.get("streaming"), hint=hint
)
# Check wal_level parameter: must be different from 'minimal'
# the parameter has been introduced in postgres >= 9.0
if "wal_level" in remote_status:
check_strategy.init_check("wal_level")
if remote_status["wal_level"] != "minimal":
check_strategy.result(self.config.name, True)
else:
check_strategy.result(
self.config.name,
False,
hint="please set it to a higher level than 'minimal'",
)
# Check the presence and the status of the configured replication slot
# This check will be skipped if `slot_name` is undefined
if self.config.slot_name:
check_strategy.init_check("replication slot")
slot = remote_status["replication_slot"]
# The streaming_archiver is enabled
if self.config.streaming_archiver is True:
# Error if PostgreSQL is too old
if not remote_status["replication_slot_support"]:
check_strategy.result(
self.config.name,
False,
hint="slot_name parameter set but PostgreSQL server "
"is too old (%s < 9.4)" % remote_status["server_txt_version"],
)
# Replication slots are supported
else:
# The slot is not present
if slot is None:
check_strategy.result(
self.config.name,
False,
hint="replication slot '%s' doesn't exist. "
"Please execute 'barman receive-wal "
"--create-slot %s'"
% (self.config.slot_name, self.config.name),
)
else:
# The slot is present but not initialised
if slot.restart_lsn is None:
check_strategy.result(
self.config.name,
False,
hint="slot '%s' not initialised: is "
"'receive-wal' running?" % self.config.slot_name,
)
# The slot is present but not active
elif slot.active is False:
check_strategy.result(
self.config.name,
False,
hint="slot '%s' not active: is "
"'receive-wal' running?" % self.config.slot_name,
)
else:
check_strategy.result(self.config.name, True)
else:
# If the streaming_archiver is disabled and the slot_name
# option is present in the configuration, we check that
# a replication slot with the specified name is NOT present
# and NOT active.
# NOTE: This is not a failure, just a warning.
if slot is not None:
if slot.restart_lsn is not None:
slot_status = "initialised"
# Check if the slot is also active
if slot.active:
slot_status = "active"
# Warn the user
check_strategy.result(
self.config.name,
True,
hint="WARNING: slot '%s' is %s but not required "
"by the current config"
% (self.config.slot_name, slot_status),
)
def _make_directories(self):
"""
Make backup directories in case they do not exist
"""
for key in self.config.KEYS:
if key.endswith("_directory") and hasattr(self.config, key):
val = getattr(self.config, key)
if val is not None and not os.path.isdir(val):
# noinspection PyTypeChecker
os.makedirs(val)
def check_directories(self, check_strategy):
"""
Checks backup directories and creates them if they do not exist
:param CheckStrategy check_strategy: the strategy for the management
of the results of the various checks
"""
check_strategy.init_check("directories")
if not self.config.disabled:
try:
self._make_directories()
except OSError as e:
check_strategy.result(
self.config.name, False, "%s: %s" % (e.filename, e.strerror)
)
else:
check_strategy.result(self.config.name, True)
def check_configuration(self, check_strategy):
"""
Check for error messages in the message list
of the server and output eventual errors
:param CheckStrategy check_strategy: the strategy for the management
of the results of the various checks
"""
check_strategy.init_check("configuration")
if len(self.config.msg_list):
check_strategy.result(self.config.name, False)
for conflict_paths in self.config.msg_list:
output.info("\t\t%s" % conflict_paths)
def check_retention_policy_settings(self, check_strategy):
"""
Checks retention policy setting
:param CheckStrategy check_strategy: the strategy for the management
of the results of the various checks
"""
check_strategy.init_check("retention policy settings")
config = self.config
if config.retention_policy and not self.enforce_retention_policies:
check_strategy.result(self.config.name, False, hint="see log")
else:
check_strategy.result(self.config.name, True)
def check_backup_validity(self, check_strategy):
"""
Check if backup validity requirements are satisfied
:param CheckStrategy check_strategy: the strategy for the management
of the results of the various checks
"""
check_strategy.init_check("backup maximum age")
# first check: check backup maximum age
if self.config.last_backup_maximum_age is not None:
# get maximum age information
backup_age = self.backup_manager.validate_last_backup_maximum_age(
self.config.last_backup_maximum_age
)
# format the output
check_strategy.result(
self.config.name,
backup_age[0],
hint="interval provided: %s, latest backup age: %s"
% (
human_readable_timedelta(self.config.last_backup_maximum_age),
backup_age[1],
),
)
else:
# last_backup_maximum_age provided by the user
check_strategy.result(
self.config.name, True, hint="no last_backup_maximum_age provided"
)
# second check: check backup minimum size
check_strategy.init_check("backup minimum size")
if self.config.last_backup_minimum_size is not None:
backup_size = self.backup_manager.validate_last_backup_min_size(
self.config.last_backup_minimum_size
)
gtlt = ">" if backup_size[0] else "<"
check_strategy.result(
self.config.name,
backup_size[0],
hint="last backup size %s %s %s minimum"
% (
pretty_size(backup_size[1]),
gtlt,
pretty_size(self.config.last_backup_minimum_size),
),
perfdata=backup_size[1],
)
else:
# no last_backup_minimum_size provided by the user
backup_size = self.backup_manager.validate_last_backup_min_size(0)
check_strategy.result(
self.config.name,
True,
hint=pretty_size(backup_size[1]),
perfdata=backup_size[1],
)
def _check_wal_info(self, wal_info, last_wal_maximum_age):
"""
Checks the supplied wal_info is within the last_wal_maximum_age.
:param last_backup_minimum_age: timedelta representing the time from now
during which a WAL is considered valid
:return tuple: a tuple containing the boolean result of the check, a string
with auxiliary information about the check, and an integer representing
the size of the WAL in bytes
"""
wal_last = datetime.datetime.fromtimestamp(
wal_info["wal_last_timestamp"], dateutil.tz.tzlocal()
)
now = datetime.datetime.now(dateutil.tz.tzlocal())
wal_age = now - wal_last
if wal_age <= last_wal_maximum_age:
wal_age_isok = True
else:
wal_age_isok = False
wal_message = "interval provided: %s, latest wal age: %s" % (
human_readable_timedelta(last_wal_maximum_age),
human_readable_timedelta(wal_age),
)
if wal_info["wal_until_next_size"] is None:
wal_size = 0
else:
wal_size = wal_info["wal_until_next_size"]
return wal_age_isok, wal_message, wal_size
def check_wal_validity(self, check_strategy):
"""
Check if wal archiving requirements are satisfied
"""
check_strategy.init_check("wal maximum age")
backup_id = self.backup_manager.get_last_backup_id()
backup_info = self.get_backup(backup_id)
if backup_info is not None:
wal_info = self.get_wal_info(backup_info)
# first check: check wal maximum age
if self.config.last_wal_maximum_age is not None:
# get maximum age information
if backup_info is None or wal_info["wal_last_timestamp"] is None:
# No WAL files received
# (we should have the .backup file, as a minimum)
# This may also be an indication that 'barman cron' is not
# running
wal_age_isok = False
wal_message = "No WAL files archived for last backup"
wal_size = 0
else:
wal_age_isok, wal_message, wal_size = self._check_wal_info(
wal_info, self.config.last_wal_maximum_age
)
# format the output
check_strategy.result(self.config.name, wal_age_isok, hint=wal_message)
else:
# no last_wal_maximum_age provided by the user
if backup_info is None or wal_info["wal_until_next_size"] is None:
wal_size = 0
else:
wal_size = wal_info["wal_until_next_size"]
check_strategy.result(
self.config.name, True, hint="no last_wal_maximum_age provided"
)
check_strategy.init_check("wal size")
check_strategy.result(
self.config.name, True, pretty_size(wal_size), perfdata=wal_size
)
def check_archiver_errors(self, check_strategy):
"""
Checks the presence of archiving errors
:param CheckStrategy check_strategy: the strategy for the management
of the results of the check
"""
check_strategy.init_check("archiver errors")
if os.path.isdir(self.config.errors_directory):
errors = os.listdir(self.config.errors_directory)
else:
errors = []
check_strategy.result(
self.config.name,
len(errors) == 0,
hint=WalArchiver.summarise_error_files(errors),
)
def check_identity(self, check_strategy):
"""
Check the systemid retrieved from the streaming connection
is the same that is retrieved from the standard connection,
and then verifies it matches the one stored on disk.
:param CheckStrategy check_strategy: the strategy for the management
of the results of the various checks
"""
check_strategy.init_check("systemid coherence")
remote_status = self.get_remote_status()
# Get system identifier from streaming and standard connections
systemid_from_streaming = remote_status.get("streaming_systemid")
systemid_from_postgres = remote_status.get("postgres_systemid")
# If both available, makes sure they are coherent with each other
if systemid_from_streaming and systemid_from_postgres:
if systemid_from_streaming != systemid_from_postgres:
check_strategy.result(
self.config.name,
systemid_from_streaming == systemid_from_postgres,
hint="is the streaming DSN targeting the same server "
"of the PostgreSQL connection string?",
)
return
systemid_from_server = systemid_from_streaming or systemid_from_postgres
if not systemid_from_server:
# Can't check without system Id information
check_strategy.result(self.config.name, True, hint="no system Id available")
return
# Retrieves the content on disk and matches it with the live ID
file_path = self.get_identity_file_path()
if not os.path.exists(file_path):
# We still don't have the systemid cached on disk,
# so let's wait until we store it
check_strategy.result(
self.config.name, True, hint="no system Id stored on disk"
)
return
identity_from_file = self.read_identity_file()
if systemid_from_server != identity_from_file.get("systemid"):
check_strategy.result(
self.config.name,
False,
hint="the system Id of the connected PostgreSQL server "
'changed, stored in "%s"' % file_path,
)
else:
check_strategy.result(self.config.name, True)
def status_postgres(self):
"""
Status of PostgreSQL server
"""
remote_status = self.get_remote_status()
if remote_status["server_txt_version"]:
output.result(
"status",
self.config.name,
"pg_version",
"PostgreSQL version",
remote_status["server_txt_version"],
)
else:
output.result(
"status",
self.config.name,
"pg_version",
"PostgreSQL version",
"FAILED trying to get PostgreSQL version",
)
return
# Define the cluster state as pg_controldata do.
if remote_status["is_in_recovery"]:
output.result(
"status",
self.config.name,
"is_in_recovery",
"Cluster state",
"in archive recovery",
)
else:
output.result(
"status",
self.config.name,
"is_in_recovery",
"Cluster state",
"in production",
)
if remote_status["pgespresso_installed"]:
output.result(
"status",
self.config.name,
"pgespresso",
"pgespresso extension",
"Available",
)
else:
output.result(
"status",
self.config.name,
"pgespresso",
"pgespresso extension",
"Not available",
)
if remote_status.get("current_size") is not None:
output.result(
"status",
self.config.name,
"current_size",
"Current data size",
pretty_size(remote_status["current_size"]),
)
if remote_status["data_directory"]:
output.result(
"status",
self.config.name,
"data_directory",
"PostgreSQL Data directory",
remote_status["data_directory"],
)
if remote_status["current_xlog"]:
output.result(
"status",
self.config.name,
"current_xlog",
"Current WAL segment",
remote_status["current_xlog"],
)
def status_wal_archiver(self):
"""
Status of WAL archiver(s)
"""
for archiver in self.archivers:
archiver.status()
def status_retention_policies(self):
"""
Status of retention policies enforcement
"""
if self.enforce_retention_policies:
output.result(
"status",
self.config.name,
"retention_policies",
"Retention policies",
"enforced "
"(mode: %s, retention: %s, WAL retention: %s)"
% (
self.config.retention_policy_mode,
self.config.retention_policy,
self.config.wal_retention_policy,
),
)
else:
output.result(
"status",
self.config.name,
"retention_policies",
"Retention policies",
"not enforced",
)
def status(self):
"""
Implements the 'server-status' command.
"""
if self.config.description:
output.result(
"status",
self.config.name,
"description",
"Description",
self.config.description,
)
output.result(
"status", self.config.name, "active", "Active", self.config.active
)
output.result(
"status", self.config.name, "disabled", "Disabled", self.config.disabled
)
# Postgres status is available only if node is not passive
if not self.passive_node:
self.status_postgres()
self.status_wal_archiver()
output.result(
"status",
self.config.name,
"passive_node",
"Passive node",
self.passive_node,
)
self.status_retention_policies()
# Executes the backup manager status info method
self.backup_manager.status()
def fetch_remote_status(self):
"""
Get the status of the remote server
This method does not raise any exception in case of errors,
but set the missing values to None in the resulting dictionary.
:rtype: dict[str, None|str]
"""
result = {}
# Merge status for a postgres connection
if self.postgres:
result.update(self.postgres.get_remote_status())
# Merge status for a streaming connection
if self.streaming:
result.update(self.streaming.get_remote_status())
# Merge status for each archiver
for archiver in self.archivers:
result.update(archiver.get_remote_status())
# Merge status defined by the BackupManager
result.update(self.backup_manager.get_remote_status())
return result
def show(self):
"""
Shows the server configuration
"""
# Populate result map with all the required keys
result = self.config.to_json()
# Is the server a passive node?
result["passive_node"] = self.passive_node
# Skip remote status if the server is passive
if not self.passive_node:
remote_status = self.get_remote_status()
result.update(remote_status)
# Backup maximum age section
if self.config.last_backup_maximum_age is not None:
age = self.backup_manager.validate_last_backup_maximum_age(
self.config.last_backup_maximum_age
)
# If latest backup is between the limits of the
# last_backup_maximum_age configuration, display how old is
# the latest backup.
if age[0]:
msg = "%s (latest backup: %s )" % (
human_readable_timedelta(self.config.last_backup_maximum_age),
age[1],
)
else:
# If latest backup is outside the limits of the
# last_backup_maximum_age configuration (or the configuration
# value is none), warn the user.
msg = "%s (WARNING! latest backup is %s old)" % (
human_readable_timedelta(self.config.last_backup_maximum_age),
age[1],
)
result["last_backup_maximum_age"] = msg
else:
result["last_backup_maximum_age"] = "None"
output.result("show_server", self.config.name, result)
def delete_backup(self, backup):
"""Deletes a backup
:param backup: the backup to delete
"""
try:
# Lock acquisition: if you can acquire a ServerBackupLock
# it means that no backup process is running on that server,
# so there is no need to check the backup status.
# Simply proceed with the normal delete process.
server_backup_lock = ServerBackupLock(
self.config.barman_lock_directory, self.config.name
)
server_backup_lock.acquire(
server_backup_lock.raise_if_fail, server_backup_lock.wait
)
server_backup_lock.release()
except LockFileBusy:
# Otherwise if the lockfile is busy, a backup process is actually
# running on that server. To be sure that it's safe
# to delete the backup, we must check its status and its position
# in the catalogue.
# If it is the first and it is STARTED or EMPTY, we are trying to
# remove a running backup. This operation must be forbidden.
# Otherwise, normally delete the backup.
first_backup_id = self.get_first_backup_id(BackupInfo.STATUS_ALL)
if backup.backup_id == first_backup_id and backup.status in (
BackupInfo.STARTED,
BackupInfo.EMPTY,
):
output.error(
"Cannot delete a running backup (%s %s)"
% (self.config.name, backup.backup_id)
)
return
except LockFilePermissionDenied as e:
# We cannot access the lockfile.
# Exit without removing the backup.
output.error("Permission denied, unable to access '%s'" % e)
return
try:
# Take care of the backup lock.
# Only one process can modify a backup at a time
lock = ServerBackupIdLock(
self.config.barman_lock_directory, self.config.name, backup.backup_id
)
with lock:
deleted = self.backup_manager.delete_backup(backup)
# At this point no-one should try locking a backup that
# doesn't exists, so we can remove the lock
# WARNING: the previous statement is true only as long as
# no-one wait on this lock
if deleted:
os.remove(lock.filename)
return deleted
except LockFileBusy:
# If another process is holding the backup lock,
# warn the user and terminate
output.error(
"Another process is holding the lock for "
"backup %s of server %s." % (backup.backup_id, self.config.name)
)
return
except LockFilePermissionDenied as e:
# We cannot access the lockfile.
# warn the user and terminate
output.error("Permission denied, unable to access '%s'" % e)
return
def backup(self, wait=False, wait_timeout=None):
"""
Performs a backup for the server
:param bool wait: wait for all the required WAL files to be archived
:param int|None wait_timeout: the time, in seconds, the backup
will wait for the required WAL files to be archived
before timing out
"""
# The 'backup' command is not available on a passive node.
# We assume that if we get here the node is not passive
assert not self.passive_node
try:
# Default strategy for check in backup is CheckStrategy
# This strategy does not print any output - it only logs checks
strategy = CheckStrategy()
self.check(strategy)
if strategy.has_error:
output.error(
"Impossible to start the backup. Check the log "
"for more details, or run 'barman check %s'" % self.config.name
)
return
# check required backup directories exist
self._make_directories()
except OSError as e:
output.error("failed to create %s directory: %s", e.filename, e.strerror)
return
# Save the database identity
self.write_identity_file()
# Make sure we are not wasting an precious streaming PostgreSQL
# connection that may have been opened by the self.check() call
if self.streaming:
self.streaming.close()
try:
# lock acquisition and backup execution
with ServerBackupLock(self.config.barman_lock_directory, self.config.name):
backup_info = self.backup_manager.backup(
wait=wait, wait_timeout=wait_timeout
)
# Archive incoming WALs and update WAL catalogue
self.archive_wal(verbose=False)
# Invoke sanity check of the backup
if backup_info.status == BackupInfo.WAITING_FOR_WALS:
self.check_backup(backup_info)
# At this point is safe to remove any remaining WAL file before the
# first backup
previous_backup = self.get_previous_backup(backup_info.backup_id)
if not previous_backup:
self.backup_manager.remove_wal_before_backup(backup_info)
if backup_info.status == BackupInfo.WAITING_FOR_WALS:
output.warning(
"IMPORTANT: this backup is classified as "
"WAITING_FOR_WALS, meaning that Barman has not received "
"yet all the required WAL files for the backup "
"consistency.\n"
"This is a common behaviour in concurrent backup "
"scenarios, and Barman automatically set the backup as "
"DONE once all the required WAL files have been "
"archived.\n"
"Hint: execute the backup command with '--wait'"
)
except LockFileBusy:
output.error("Another backup process is running")
except LockFilePermissionDenied as e:
output.error("Permission denied, unable to access '%s'" % e)
def get_available_backups(self, status_filter=BackupManager.DEFAULT_STATUS_FILTER):
"""
Get a list of available backups
param: status_filter: the status of backups to return,
default to BackupManager.DEFAULT_STATUS_FILTER
"""
return self.backup_manager.get_available_backups(status_filter)
def get_last_backup_id(self, status_filter=BackupManager.DEFAULT_STATUS_FILTER):
"""
Get the id of the latest/last backup in the catalog (if exists)
:param status_filter: The status of the backup to return,
default to DEFAULT_STATUS_FILTER.
:return string|None: ID of the backup
"""
return self.backup_manager.get_last_backup_id(status_filter)
def get_first_backup_id(self, status_filter=BackupManager.DEFAULT_STATUS_FILTER):
"""
Get the id of the oldest/first backup in the catalog (if exists)
:param status_filter: The status of the backup to return,
default to DEFAULT_STATUS_FILTER.
:return string|None: ID of the backup
"""
return self.backup_manager.get_first_backup_id(status_filter)
def list_backups(self):
"""
Lists all the available backups for the server
"""
retention_status = self.report_backups()
backups = self.get_available_backups(BackupInfo.STATUS_ALL)
for key in sorted(backups.keys(), reverse=True):
backup = backups[key]
backup_size = backup.size or 0
wal_size = 0
rstatus = None
if backup.status in BackupInfo.STATUS_COPY_DONE:
try:
wal_info = self.get_wal_info(backup)
backup_size += wal_info["wal_size"]
wal_size = wal_info["wal_until_next_size"]
except BadXlogSegmentName as e:
output.error(
"invalid WAL segment name %r\n"
'HINT: Please run "barman rebuild-xlogdb %s" '
"to solve this issue",
force_str(e),
self.config.name,
)
if (
self.enforce_retention_policies
and retention_status[backup.backup_id] != BackupInfo.VALID
):
rstatus = retention_status[backup.backup_id]
output.result("list_backup", backup, backup_size, wal_size, rstatus)
def get_backup(self, backup_id):
"""
Return the backup information for the given backup id.
If the backup_id is None or backup.info file doesn't exists,
it returns None.
:param str|None backup_id: the ID of the backup to return
:rtype: barman.infofile.LocalBackupInfo|None
"""
return self.backup_manager.get_backup(backup_id)
def get_previous_backup(self, backup_id):
"""
Get the previous backup (if any) from the catalog
:param backup_id: the backup id from which return the previous
"""
return self.backup_manager.get_previous_backup(backup_id)
def get_next_backup(self, backup_id):
"""
Get the next backup (if any) from the catalog
:param backup_id: the backup id from which return the next
"""
return self.backup_manager.get_next_backup(backup_id)
def get_required_xlog_files(
self, backup, target_tli=None, target_time=None, target_xid=None
):
"""
Get the xlog files required for a recovery
params: BackupInfo backup: a backup object
params: target_tli : target timeline
param: target_time: target time
"""
begin = backup.begin_wal
end = backup.end_wal
# If timeline isn't specified, assume it is the same timeline
# of the backup
if not target_tli:
target_tli, _, _ = xlog.decode_segment_name(end)
with self.xlogdb() as fxlogdb:
for line in fxlogdb:
wal_info = WalFileInfo.from_xlogdb_line(line)
# Handle .history files: add all of them to the output,
# regardless of their age
if xlog.is_history_file(wal_info.name):
yield wal_info
continue
if wal_info.name < begin:
continue
tli, _, _ = xlog.decode_segment_name(wal_info.name)
if tli > target_tli:
continue
yield wal_info
if wal_info.name > end:
end = wal_info.name
if target_time and wal_info.time > target_time:
break
# return all the remaining history files
for line in fxlogdb:
wal_info = WalFileInfo.from_xlogdb_line(line)
if xlog.is_history_file(wal_info.name):
yield wal_info
# TODO: merge with the previous
def get_wal_until_next_backup(self, backup, include_history=False):
"""
Get the xlog files between backup and the next
:param BackupInfo backup: a backup object, the starting point
to retrieve WALs
:param bool include_history: option for the inclusion of
include_history files into the output
"""
begin = backup.begin_wal
next_end = None
if self.get_next_backup(backup.backup_id):
next_end = self.get_next_backup(backup.backup_id).end_wal
backup_tli, _, _ = xlog.decode_segment_name(begin)
with self.xlogdb() as fxlogdb:
for line in fxlogdb:
wal_info = WalFileInfo.from_xlogdb_line(line)
# Handle .history files: add all of them to the output,
# regardless of their age, if requested (the 'include_history'
# parameter is True)
if xlog.is_history_file(wal_info.name):
if include_history:
yield wal_info
continue
if wal_info.name < begin:
continue
tli, _, _ = xlog.decode_segment_name(wal_info.name)
if tli > backup_tli:
continue
if not xlog.is_wal_file(wal_info.name):
continue
if next_end and wal_info.name > next_end:
break
yield wal_info
def get_wal_full_path(self, wal_name):
"""
Build the full path of a WAL for a server given the name
:param wal_name: WAL file name
"""
# Build the path which contains the file
hash_dir = os.path.join(self.config.wals_directory, xlog.hash_dir(wal_name))
# Build the WAL file full path
full_path = os.path.join(hash_dir, wal_name)
return full_path
def get_wal_possible_paths(self, wal_name, partial=False):
"""
Build a list of possible positions of a WAL file
:param str wal_name: WAL file name
:param bool partial: add also the '.partial' paths
"""
paths = list()
# Path in the archive
hash_dir = os.path.join(self.config.wals_directory, xlog.hash_dir(wal_name))
full_path = os.path.join(hash_dir, wal_name)
paths.append(full_path)
# Path in incoming directory
incoming_path = os.path.join(self.config.incoming_wals_directory, wal_name)
paths.append(incoming_path)
# Path in streaming directory
streaming_path = os.path.join(self.config.streaming_wals_directory, wal_name)
paths.append(streaming_path)
# If partial files are required check also the '.partial' path
if partial:
paths.append(streaming_path + PARTIAL_EXTENSION)
# Add the streaming_path again to handle races with pg_receivewal
# completing the WAL file
paths.append(streaming_path)
# The following two path are only useful to retrieve the last
# incomplete segment archived before a promotion.
paths.append(full_path + PARTIAL_EXTENSION)
paths.append(incoming_path + PARTIAL_EXTENSION)
# Append the archive path again, to handle races with the archiver
paths.append(full_path)
return paths
def get_wal_info(self, backup_info):
"""
Returns information about WALs for the given backup
:param barman.infofile.LocalBackupInfo backup_info: the target backup
"""
begin = backup_info.begin_wal
end = backup_info.end_wal
# counters
wal_info = dict.fromkeys(
(
"wal_num",
"wal_size",
"wal_until_next_num",
"wal_until_next_size",
"wal_until_next_compression_ratio",
"wal_compression_ratio",
),
0,
)
# First WAL (always equal to begin_wal) and Last WAL names and ts
wal_info["wal_first"] = None
wal_info["wal_first_timestamp"] = None
wal_info["wal_last"] = None
wal_info["wal_last_timestamp"] = None
# WAL rate (default 0.0 per second)
wal_info["wals_per_second"] = 0.0
for item in self.get_wal_until_next_backup(backup_info):
if item.name == begin:
wal_info["wal_first"] = item.name
wal_info["wal_first_timestamp"] = item.time
if item.name <= end:
wal_info["wal_num"] += 1
wal_info["wal_size"] += item.size
else:
wal_info["wal_until_next_num"] += 1
wal_info["wal_until_next_size"] += item.size
wal_info["wal_last"] = item.name
wal_info["wal_last_timestamp"] = item.time
# Calculate statistics only for complete backups
# If the cron is not running for any reason, the required
# WAL files could be missing
if wal_info["wal_first"] and wal_info["wal_last"]:
# Estimate WAL ratio
# Calculate the difference between the timestamps of
# the first WAL (begin of backup) and the last WAL
# associated to the current backup
wal_last_timestamp = wal_info["wal_last_timestamp"]
wal_first_timestamp = wal_info["wal_first_timestamp"]
wal_info["wal_total_seconds"] = wal_last_timestamp - wal_first_timestamp
if wal_info["wal_total_seconds"] > 0:
wal_num = wal_info["wal_num"]
wal_until_next_num = wal_info["wal_until_next_num"]
wal_total_seconds = wal_info["wal_total_seconds"]
wal_info["wals_per_second"] = (
float(wal_num + wal_until_next_num) / wal_total_seconds
)
# evaluation of compression ratio for basebackup WAL files
wal_info["wal_theoretical_size"] = wal_info["wal_num"] * float(
backup_info.xlog_segment_size
)
try:
wal_size = wal_info["wal_size"]
wal_info["wal_compression_ratio"] = 1 - (
wal_size / wal_info["wal_theoretical_size"]
)
except ZeroDivisionError:
wal_info["wal_compression_ratio"] = 0.0
# evaluation of compression ratio of WAL files
wal_until_next_num = wal_info["wal_until_next_num"]
wal_info["wal_until_next_theoretical_size"] = wal_until_next_num * float(
backup_info.xlog_segment_size
)
try:
wal_until_next_size = wal_info["wal_until_next_size"]
until_next_theoretical_size = wal_info[
"wal_until_next_theoretical_size"
]
wal_info["wal_until_next_compression_ratio"] = 1 - (
wal_until_next_size / until_next_theoretical_size
)
except ZeroDivisionError:
wal_info["wal_until_next_compression_ratio"] = 0.0
return wal_info
def recover(
self, backup_info, dest, tablespaces=None, remote_command=None, **kwargs
):
"""
Performs a recovery of a backup
:param barman.infofile.LocalBackupInfo backup_info: the backup
to recover
:param str dest: the destination directory
:param dict[str,str]|None tablespaces: a tablespace
name -> location map (for relocation)
:param str|None remote_command: default None. The remote command to
recover the base backup, in case of remote backup.
:kwparam str|None target_tli: the target timeline
:kwparam str|None target_time: the target time
:kwparam str|None target_xid: the target xid
:kwparam str|None target_lsn: the target LSN
:kwparam str|None target_name: the target name created previously with
pg_create_restore_point() function call
:kwparam bool|None target_immediate: end recovery as soon as
consistency is reached
:kwparam bool exclusive: whether the recovery is exclusive or not
:kwparam str|None target_action: the recovery target action
:kwparam bool|None standby_mode: the standby mode
"""
return self.backup_manager.recover(
backup_info, dest, tablespaces, remote_command, **kwargs
)
def get_wal(
self,
wal_name,
compression=None,
output_directory=None,
peek=None,
partial=False,
):
"""
Retrieve a WAL file from the archive
:param str wal_name: id of the WAL file to find into the WAL archive
:param str|None compression: compression format for the output
:param str|None output_directory: directory where to deposit the
WAL file
:param int|None peek: if defined list the next N WAL file
:param bool partial: retrieve also partial WAL files
"""
# If used through SSH identify the client to add it to logs
source_suffix = ""
ssh_connection = os.environ.get("SSH_CONNECTION")
if ssh_connection:
# The client IP is the first value contained in `SSH_CONNECTION`
# which contains four space-separated values: client IP address,
# client port number, server IP address, and server port number.
source_suffix = " (SSH host: %s)" % (ssh_connection.split()[0],)
# Sanity check
if not xlog.is_any_xlog_file(wal_name):
output.error(
"'%s' is not a valid wal file name%s",
wal_name,
source_suffix,
exit_code=3,
)
return
# If peek is requested we only output a list of files
if peek:
# Get the next ``peek`` files following the provided ``wal_name``.
# If ``wal_name`` is not a simple wal file,
# we cannot guess the names of the following WAL files.
# So ``wal_name`` is the only possible result, if exists.
if xlog.is_wal_file(wal_name):
# We can't know what was the segment size of PostgreSQL WAL
# files at backup time. Because of this, we generate all
# the possible names for a WAL segment, and then we check
# if the requested one is included.
wal_peek_list = xlog.generate_segment_names(wal_name)
else:
wal_peek_list = iter([wal_name])
# Output the content of wal_peek_list until we have displayed
# enough files or find a missing file
count = 0
while count < peek:
try:
wal_peek_name = next(wal_peek_list)
except StopIteration:
# No more item in wal_peek_list
break
# Get list of possible location. We do not prefetch
# partial files
wal_peek_paths = self.get_wal_possible_paths(
wal_peek_name, partial=False
)
# If the next WAL file is found, output the name
# and continue to the next one
if any(os.path.exists(path) for path in wal_peek_paths):
count += 1
output.info(wal_peek_name, log=False)
continue
# If ``wal_peek_file`` doesn't exist, check if we need to
# look in the following segment
tli, log, seg = xlog.decode_segment_name(wal_peek_name)
# If `seg` is not a power of two, it is not possible that we
# are at the end of a WAL group, so we are done
if not is_power_of_two(seg):
break
# This is a possible WAL group boundary, let's try the
# following group
seg = 0
log += 1
# Install a new generator from the start of the next segment.
# If the file doesn't exists we will terminate because
# zero is not a power of two
wal_peek_name = xlog.encode_segment_name(tli, log, seg)
wal_peek_list = xlog.generate_segment_names(wal_peek_name)
# Do not output anything else
return
# If an output directory was provided write the file inside it
# otherwise we use standard output
if output_directory is not None:
destination_path = os.path.join(output_directory, wal_name)
destination_description = "into '%s' file" % destination_path
# Use the standard output for messages
logger = output
try:
destination = open(destination_path, "wb")
except IOError as e:
output.error(
"Unable to open '%s' file%s: %s",
destination_path,
source_suffix,
e,
exit_code=3,
)
return
else:
destination_description = "to standard output"
# Do not use the standard output for messages, otherwise we would
# taint the output stream
logger = _logger
try:
# Python 3.x
destination = sys.stdout.buffer
except AttributeError:
# Python 2.x
destination = sys.stdout
# Get the list of WAL file possible paths
wal_paths = self.get_wal_possible_paths(wal_name, partial)
for wal_file in wal_paths:
# Check for file existence
if not os.path.exists(wal_file):
continue
logger.info(
"Sending WAL '%s' for server '%s' %s%s",
os.path.basename(wal_file),
self.config.name,
destination_description,
source_suffix,
)
try:
# Try returning the wal_file to the client
self.get_wal_sendfile(wal_file, compression, destination)
# We are done, return to the caller
return
except CommandFailedException:
# If an external command fails we cannot really know why,
# but if the WAL file disappeared, we assume
# it has been moved in the archive so we ignore the error.
# This file will be retrieved later, as the last entry
# returned by get_wal_possible_paths() is the archive position
if not os.path.exists(wal_file):
pass
else:
raise
except OSError as exc:
# If the WAL file disappeared just ignore the error
# This file will be retrieved later, as the last entry
# returned by get_wal_possible_paths() is the archive
# position
if exc.errno == errno.ENOENT and exc.filename == wal_file:
pass
else:
raise
logger.info("Skipping vanished WAL file '%s'%s", wal_file, source_suffix)
output.error(
"WAL file '%s' not found in server '%s'%s",
wal_name,
self.config.name,
source_suffix,
)
def get_wal_sendfile(self, wal_file, compression, destination):
"""
Send a WAL file to the destination file, using the required compression
:param str wal_file: WAL file path
:param str compression: required compression
:param destination: file stream to use to write the data
"""
# Identify the wal file
wal_info = self.backup_manager.compression_manager.get_wal_file_info(wal_file)
# Get a decompressor for the file (None if not compressed)
wal_compressor = self.backup_manager.compression_manager.get_compressor(
wal_info.compression
)
# Get a compressor for the output (None if not compressed)
out_compressor = self.backup_manager.compression_manager.get_compressor(
compression
)
# Initially our source is the stored WAL file and we do not have
# any temporary file
source_file = wal_file
uncompressed_file = None
compressed_file = None
# If the required compression is different from the source we
# decompress/compress it into the required format (getattr is
# used here to gracefully handle None objects)
if getattr(wal_compressor, "compression", None) != getattr(
out_compressor, "compression", None
):
# If source is compressed, decompress it into a temporary file
if wal_compressor is not None:
uncompressed_file = NamedTemporaryFile(
dir=self.config.wals_directory,
prefix=".%s." % os.path.basename(wal_file),
suffix=".uncompressed",
)
# decompress wal file
wal_compressor.decompress(source_file, uncompressed_file.name)
source_file = uncompressed_file.name
# If output compression is required compress the source
# into a temporary file
if out_compressor is not None:
compressed_file = NamedTemporaryFile(
dir=self.config.wals_directory,
prefix=".%s." % os.path.basename(wal_file),
suffix=".compressed",
)
out_compressor.compress(source_file, compressed_file.name)
source_file = compressed_file.name
# Copy the prepared source file to destination
with open(source_file, "rb") as input_file:
shutil.copyfileobj(input_file, destination)
# Remove temp files
if uncompressed_file is not None:
uncompressed_file.close()
if compressed_file is not None:
compressed_file.close()
def put_wal(self, fileobj):
"""
Receive a WAL file from SERVER_NAME and securely store it in the
incoming directory.
The file will be read from the fileobj passed as parameter.
"""
# If used through SSH identify the client to add it to logs
source_suffix = ""
ssh_connection = os.environ.get("SSH_CONNECTION")
if ssh_connection:
# The client IP is the first value contained in `SSH_CONNECTION`
# which contains four space-separated values: client IP address,
# client port number, server IP address, and server port number.
source_suffix = " (SSH host: %s)" % (ssh_connection.split()[0],)
# Incoming directory is where the files will be extracted
dest_dir = self.config.incoming_wals_directory
# Ensure the presence of the destination directory
mkpath(dest_dir)
incoming_file = namedtuple(
"incoming_file",
[
"name",
"tmp_path",
"path",
"checksum",
],
)
# Stream read tar from stdin, store content in incoming directory
# The closing wrapper is needed only for Python 2.6
extracted_files = {}
validated_files = {}
md5sums = {}
try:
with closing(tarfile.open(mode="r|", fileobj=fileobj)) as tar:
for item in tar:
name = item.name
# Strip leading './' - tar has been manually created
if name.startswith("./"):
name = name[2:]
# Requires a regular file as tar item
if not item.isreg():
output.error(
"Unsupported file type '%s' for file '%s' "
"in put-wal for server '%s'%s",
item.type,
name,
self.config.name,
source_suffix,
)
return
# Subdirectories are not supported
if "/" in name:
output.error(
"Unsupported filename '%s' in put-wal for server '%s'%s",
name,
self.config.name,
source_suffix,
)
return
# Checksum file
if name == "MD5SUMS":
# Parse content and store it in md5sums dictionary
for line in tar.extractfile(item).readlines():
line = line.decode().rstrip()
try:
# Split checksums and path info
checksum, path = re.split(r" [* ]", line, 1)
except ValueError:
output.warning(
"Bad checksum line '%s' found "
"in put-wal for server '%s'%s",
line,
self.config.name,
source_suffix,
)
continue
# Strip leading './' from path in the checksum file
if path.startswith("./"):
path = path[2:]
md5sums[path] = checksum
else:
# Extract using a temp name (with PID)
tmp_path = os.path.join(
dest_dir, ".%s-%s" % (os.getpid(), name)
)
path = os.path.join(dest_dir, name)
tar.makefile(item, tmp_path)
# Set the original timestamp
tar.utime(item, tmp_path)
# Add the tuple to the dictionary of extracted files
extracted_files[name] = incoming_file(
name, tmp_path, path, file_md5(tmp_path)
)
validated_files[name] = False
# For each received checksum verify the corresponding file
for name in md5sums:
# Check that file is present in the tar archive
if name not in extracted_files:
output.error(
"Checksum without corresponding file '%s' "
"in put-wal for server '%s'%s",
name,
self.config.name,
source_suffix,
)
return
# Verify the checksum of the file
if extracted_files[name].checksum != md5sums[name]:
output.error(
"Bad file checksum '%s' (should be %s) "
"for file '%s' "
"in put-wal for server '%s'%s",
extracted_files[name].checksum,
md5sums[name],
name,
self.config.name,
source_suffix,
)
return
_logger.info(
"Received file '%s' with checksum '%s' "
"by put-wal for server '%s'%s",
name,
md5sums[name],
self.config.name,
source_suffix,
)
validated_files[name] = True
# Put the files in the final place, atomically and fsync all
for item in extracted_files.values():
# Final verification of checksum presence for each file
if not validated_files[item.name]:
output.error(
"Missing checksum for file '%s' "
"in put-wal for server '%s'%s",
item.name,
self.config.name,
source_suffix,
)
return
# If a file with the same name exists, returns an error.
# PostgreSQL archive command will retry again later and,
# at that time, Barman's WAL archiver should have already
# managed this file.
if os.path.exists(item.path):
output.error(
"Impossible to write already existing file '%s' "
"in put-wal for server '%s'%s",
item.name,
self.config.name,
source_suffix,
)
return
os.rename(item.tmp_path, item.path)
fsync_file(item.path)
fsync_dir(dest_dir)
finally:
# Cleanup of any remaining temp files (where applicable)
for item in extracted_files.values():
if os.path.exists(item.tmp_path):
os.unlink(item.tmp_path)
def cron(self, wals=True, retention_policies=True, keep_descriptors=False):
"""
Maintenance operations
:param bool wals: WAL archive maintenance
:param bool retention_policies: retention policy maintenance
:param bool keep_descriptors: whether to keep subprocess descriptors,
defaults to False
"""
try:
# Actually this is the highest level of locking in the cron,
# this stops the execution of multiple cron on the same server
with ServerCronLock(self.config.barman_lock_directory, self.config.name):
# When passive call sync.cron() and never run
# local WAL archival
if self.passive_node:
self.sync_cron(keep_descriptors)
# WAL management and maintenance
elif wals:
# Execute the archive-wal sub-process
self.cron_archive_wal(keep_descriptors)
if self.config.streaming_archiver:
# Spawn the receive-wal sub-process
self.cron_receive_wal(keep_descriptors)
else:
# Terminate the receive-wal sub-process if present
self.kill("receive-wal", fail_if_not_present=False)
# Verify backup
self.cron_check_backup(keep_descriptors)
# Retention policies execution
if retention_policies:
self.backup_manager.cron_retention_policy()
except LockFileBusy:
output.info(
"Another cron process is already running on server %s. "
"Skipping to the next server" % self.config.name
)
except LockFilePermissionDenied as e:
output.error("Permission denied, unable to access '%s'" % e)
except (OSError, IOError) as e:
output.error("%s", e)
def cron_archive_wal(self, keep_descriptors):
"""
Method that handles the start of an 'archive-wal' sub-process.
This method must be run protected by ServerCronLock
:param bool keep_descriptors: whether to keep subprocess descriptors
attached to this process.
"""
try:
# Try to acquire ServerWalArchiveLock, if the lock is available,
# no other 'archive-wal' processes are running on this server.
#
# There is a very little race condition window here because
# even if we are protected by ServerCronLock, the user could run
# another 'archive-wal' command manually. However, it would result
# in one of the two commands failing on lock acquisition,
# with no other consequence.
with ServerWalArchiveLock(
self.config.barman_lock_directory, self.config.name
):
# Output and release the lock immediately
output.info(
"Starting WAL archiving for server %s", self.config.name, log=False
)
# Init a Barman sub-process object
archive_process = BarmanSubProcess(
subcommand="archive-wal",
config=barman.__config__.config_file,
args=[self.config.name],
keep_descriptors=keep_descriptors,
)
# Launch the sub-process
archive_process.execute()
except LockFileBusy:
# Another archive process is running for the server,
# warn the user and skip to the next one.
output.info(
"Another archive-wal process is already running "
"on server %s. Skipping to the next server" % self.config.name
)
def cron_receive_wal(self, keep_descriptors):
"""
Method that handles the start of a 'receive-wal' sub process
This method must be run protected by ServerCronLock
:param bool keep_descriptors: whether to keep subprocess
descriptors attached to this process.
"""
try:
# Try to acquire ServerWalReceiveLock, if the lock is available,
# no other 'receive-wal' processes are running on this server.
#
# There is a very little race condition window here because
# even if we are protected by ServerCronLock, the user could run
# another 'receive-wal' command manually. However, it would result
# in one of the two commands failing on lock acquisition,
# with no other consequence.
with ServerWalReceiveLock(
self.config.barman_lock_directory, self.config.name
):
# Output and release the lock immediately
output.info(
"Starting streaming archiver for server %s",
self.config.name,
log=False,
)
# Start a new receive-wal process
receive_process = BarmanSubProcess(
subcommand="receive-wal",
config=barman.__config__.config_file,
args=[self.config.name],
keep_descriptors=keep_descriptors,
)
# Launch the sub-process
receive_process.execute()
except LockFileBusy:
# Another receive-wal process is running for the server
# exit without message
_logger.debug(
"Another STREAMING ARCHIVER process is running for "
"server %s" % self.config.name
)
def cron_check_backup(self, keep_descriptors):
"""
Method that handles the start of a 'check-backup' sub process
:param bool keep_descriptors: whether to keep subprocess
descriptors attached to this process.
"""
backup_id = self.get_first_backup_id([BackupInfo.WAITING_FOR_WALS])
if not backup_id:
# Nothing to be done for this server
return
try:
# Try to acquire ServerBackupIdLock, if the lock is available,
# no other 'check-backup' processes are running on this backup.
#
# There is a very little race condition window here because
# even if we are protected by ServerCronLock, the user could run
# another command that takes the lock. However, it would result
# in one of the two commands failing on lock acquisition,
# with no other consequence.
with ServerBackupIdLock(
self.config.barman_lock_directory, self.config.name, backup_id
):
# Output and release the lock immediately
output.info(
"Starting check-backup for backup %s of server %s",
backup_id,
self.config.name,
log=False,
)
# Start a check-backup process
check_process = BarmanSubProcess(
subcommand="check-backup",
config=barman.__config__.config_file,
args=[self.config.name, backup_id],
keep_descriptors=keep_descriptors,
)
check_process.execute()
except LockFileBusy:
# Another process is holding the backup lock
_logger.debug(
"Another process is holding the backup lock for %s "
"of server %s" % (backup_id, self.config.name)
)
def archive_wal(self, verbose=True):
"""
Perform the WAL archiving operations.
Usually run as subprocess of the barman cron command,
but can be executed manually using the barman archive-wal command
:param bool verbose: if false outputs something only if there is
at least one file
"""
output.debug("Starting archive-wal for server %s", self.config.name)
try:
# Take care of the archive lock.
# Only one archive job per server is admitted
with ServerWalArchiveLock(
self.config.barman_lock_directory, self.config.name
):
self.backup_manager.archive_wal(verbose)
except LockFileBusy:
# If another process is running for this server,
# warn the user and skip to the next server
output.info(
"Another archive-wal process is already running "
"on server %s. Skipping to the next server" % self.config.name
)
def create_physical_repslot(self):
"""
Create a physical replication slot using the streaming connection
"""
if not self.streaming:
output.error(
"Unable to create a physical replication slot: "
"streaming connection not configured"
)
return
# Replication slots are not supported by PostgreSQL < 9.4
try:
if self.streaming.server_version < 90400:
output.error(
"Unable to create a physical replication slot: "
"not supported by '%s' "
"(9.4 or higher is required)" % self.streaming.server_major_version
)
return
except PostgresException as exc:
msg = "Cannot connect to server '%s'" % self.config.name
output.error(msg, log=False)
_logger.error("%s: %s", msg, force_str(exc).strip())
return
if not self.config.slot_name:
output.error(
"Unable to create a physical replication slot: "
"slot_name configuration option required"
)
return
output.info(
"Creating physical replication slot '%s' on server '%s'",
self.config.slot_name,
self.config.name,
)
try:
self.streaming.create_physical_repslot(self.config.slot_name)
output.info("Replication slot '%s' created", self.config.slot_name)
except PostgresDuplicateReplicationSlot:
output.error("Replication slot '%s' already exists", self.config.slot_name)
except PostgresReplicationSlotsFull:
output.error(
"All replication slots for server '%s' are in use\n"
"Free one or increase the max_replication_slots "
"value on your PostgreSQL server.",
self.config.name,
)
except PostgresException as exc:
output.error(
"Cannot create replication slot '%s' on server '%s': %s",
self.config.slot_name,
self.config.name,
force_str(exc).strip(),
)
def drop_repslot(self):
"""
Drop a replication slot using the streaming connection
"""
if not self.streaming:
output.error(
"Unable to drop a physical replication slot: "
"streaming connection not configured"
)
return
# Replication slots are not supported by PostgreSQL < 9.4
try:
if self.streaming.server_version < 90400:
output.error(
"Unable to drop a physical replication slot: "
"not supported by '%s' (9.4 or higher is "
"required)" % self.streaming.server_major_version
)
return
except PostgresException as exc:
msg = "Cannot connect to server '%s'" % self.config.name
output.error(msg, log=False)
_logger.error("%s: %s", msg, force_str(exc).strip())
return
if not self.config.slot_name:
output.error(
"Unable to drop a physical replication slot: "
"slot_name configuration option required"
)
return
output.info(
"Dropping physical replication slot '%s' on server '%s'",
self.config.slot_name,
self.config.name,
)
try:
self.streaming.drop_repslot(self.config.slot_name)
output.info("Replication slot '%s' dropped", self.config.slot_name)
except PostgresInvalidReplicationSlot:
output.error("Replication slot '%s' does not exist", self.config.slot_name)
except PostgresReplicationSlotInUse:
output.error(
"Cannot drop replication slot '%s' on server '%s' "
"because it is in use.",
self.config.slot_name,
self.config.name,
)
except PostgresException as exc:
output.error(
"Cannot drop replication slot '%s' on server '%s': %s",
self.config.slot_name,
self.config.name,
force_str(exc).strip(),
)
def receive_wal(self, reset=False):
"""
Enable the reception of WAL files using streaming protocol.
Usually started by barman cron command.
Executing this manually, the barman process will not terminate but
will continuously receive WAL files from the PostgreSQL server.
:param reset: When set, resets the status of receive-wal
"""
# Execute the receive-wal command only if streaming_archiver
# is enabled
if not self.config.streaming_archiver:
output.error(
"Unable to start receive-wal process: "
"streaming_archiver option set to 'off' in "
"barman configuration file"
)
return
if not reset:
output.info("Starting receive-wal for server %s", self.config.name)
try:
# Take care of the receive-wal lock.
# Only one receiving process per server is permitted
with ServerWalReceiveLock(
self.config.barman_lock_directory, self.config.name
):
try:
# Only the StreamingWalArchiver implementation
# does something.
# WARNING: This codes assumes that there is only one
# StreamingWalArchiver in the archivers list.
for archiver in self.archivers:
archiver.receive_wal(reset)
except ArchiverFailure as e:
output.error(e)
except LockFileBusy:
# If another process is running for this server,
if reset:
output.info(
"Unable to reset the status of receive-wal "
"for server %s. Process is still running" % self.config.name
)
else:
output.info(
"Another receive-wal process is already running "
"for server %s." % self.config.name
)
@property
def systemid(self):
"""
Get the system identifier, as returned by the PostgreSQL server
:return str: the system identifier
"""
status = self.get_remote_status()
# Main PostgreSQL connection has higher priority
if status.get("postgres_systemid"):
return status.get("postgres_systemid")
# Fallback: streaming connection
return status.get("streaming_systemid")
@property
def xlogdb_file_name(self):
"""
The name of the file containing the XLOG_DB
:return str: the name of the file that contains the XLOG_DB
"""
return os.path.join(self.config.wals_directory, self.XLOG_DB)
@contextmanager
def xlogdb(self, mode="r"):
"""
Context manager to access the xlogdb file.
This method uses locking to make sure only one process is accessing
the database at a time. The database file will be created
if it not exists.
Usage example:
with server.xlogdb('w') as file:
file.write(new_line)
:param str mode: open the file with the required mode
(default read-only)
"""
if not os.path.exists(self.config.wals_directory):
os.makedirs(self.config.wals_directory)
xlogdb = self.xlogdb_file_name
with ServerXLOGDBLock(self.config.barman_lock_directory, self.config.name):
# If the file doesn't exist and it is required to read it,
# we open it in a+ mode, to be sure it will be created
if not os.path.exists(xlogdb) and mode.startswith("r"):
if "+" not in mode:
mode = "a%s+" % mode[1:]
else:
mode = "a%s" % mode[1:]
with open(xlogdb, mode) as f:
# execute the block nested in the with statement
try:
yield f
finally:
# we are exiting the context
# if file is writable (mode contains w, a or +)
# make sure the data is written to disk
# http://docs.python.org/2/library/os.html#os.fsync
if any((c in "wa+") for c in f.mode):
f.flush()
os.fsync(f.fileno())
def report_backups(self):
if not self.enforce_retention_policies:
return dict()
else:
return self.config.retention_policy.report()
def rebuild_xlogdb(self):
"""
Rebuild the whole xlog database guessing it from the archive content.
"""
return self.backup_manager.rebuild_xlogdb()
def get_backup_ext_info(self, backup_info):
"""
Return a dictionary containing all available information about a backup
The result is equivalent to the sum of information from
* BackupInfo object
* the Server.get_wal_info() return value
* the context in the catalog (if available)
* the retention policy status
:param backup_info: the target backup
:rtype dict: all information about a backup
"""
backup_ext_info = backup_info.to_dict()
if backup_info.status in BackupInfo.STATUS_COPY_DONE:
try:
previous_backup = self.backup_manager.get_previous_backup(
backup_ext_info["backup_id"]
)
next_backup = self.backup_manager.get_next_backup(
backup_ext_info["backup_id"]
)
if previous_backup:
backup_ext_info["previous_backup_id"] = previous_backup.backup_id
else:
backup_ext_info["previous_backup_id"] = None
if next_backup:
backup_ext_info["next_backup_id"] = next_backup.backup_id
else:
backup_ext_info["next_backup_id"] = None
except UnknownBackupIdException:
# no next_backup_id and previous_backup_id items
# means "Not available"
pass
backup_ext_info.update(self.get_wal_info(backup_info))
if self.enforce_retention_policies:
policy = self.config.retention_policy
backup_ext_info["retention_policy_status"] = policy.backup_status(
backup_info.backup_id
)
else:
backup_ext_info["retention_policy_status"] = None
# Check any child timeline exists
children_timelines = self.get_children_timelines(
backup_ext_info["timeline"], forked_after=backup_info.end_xlog
)
backup_ext_info["children_timelines"] = children_timelines
return backup_ext_info
def show_backup(self, backup_info):
"""
Output all available information about a backup
:param backup_info: the target backup
"""
try:
backup_ext_info = self.get_backup_ext_info(backup_info)
output.result("show_backup", backup_ext_info)
except BadXlogSegmentName as e:
output.error(
"invalid xlog segment name %r\n"
'HINT: Please run "barman rebuild-xlogdb %s" '
"to solve this issue",
force_str(e),
self.config.name,
)
output.close_and_exit()
@staticmethod
def _build_path(path_prefix=None):
"""
If a path_prefix is provided build a string suitable to be used in
PATH environment variable by joining the path_prefix with the
current content of PATH environment variable.
If the `path_prefix` is None returns None.
:rtype: str|None
"""
if not path_prefix:
return None
sys_path = os.environ.get("PATH")
return "%s%s%s" % (path_prefix, os.pathsep, sys_path)
def kill(self, task, fail_if_not_present=True):
"""
Given the name of a barman sub-task type,
attempts to stop all the processes
:param string task: The task we want to stop
:param bool fail_if_not_present: Display an error when the process
is not present (default: True)
"""
process_list = self.process_manager.list(task)
for process in process_list:
if self.process_manager.kill(process):
output.info("Stopped process %s(%s)", process.task, process.pid)
return
else:
output.error(
"Cannot terminate process %s(%s)", process.task, process.pid
)
return
if fail_if_not_present:
output.error(
"Termination of %s failed: no such process for server %s",
task,
self.config.name,
)
def switch_wal(self, force=False, archive=None, archive_timeout=None):
"""
Execute the switch-wal command on the target server
"""
closed_wal = None
try:
if force:
# If called with force, execute a checkpoint before the
# switch_wal command
_logger.info("Force a CHECKPOINT before pg_switch_wal()")
self.postgres.checkpoint()
# Perform the switch_wal. expect a WAL name only if the switch
# has been successfully executed, False otherwise.
closed_wal = self.postgres.switch_wal()
if closed_wal is None:
# Something went wrong during the execution of the
# pg_switch_wal command
output.error(
"Unable to perform pg_switch_wal "
"for server '%s'." % self.config.name
)
return
if closed_wal:
# The switch_wal command have been executed successfully
output.info(
"The WAL file %s has been closed on server '%s'"
% (closed_wal, self.config.name)
)
else:
# Is not necessary to perform a switch_wal
output.info("No switch required for server '%s'" % self.config.name)
except PostgresIsInRecovery:
output.info(
"No switch performed because server '%s' "
"is a standby." % self.config.name
)
except PostgresSuperuserRequired:
# Superuser rights are required to perform the switch_wal
output.error("Barman switch-wal requires superuser rights")
return
# If the user has asked to wait for a WAL file to be archived,
# wait until a new WAL file has been found
# or the timeout has expired
if archive:
self.wait_for_wal(closed_wal, archive_timeout)
def wait_for_wal(self, wal_file=None, archive_timeout=None):
"""
Wait for a WAL file to be archived on the server
:param str|None wal_file: Name of the WAL file, or None if we should
just wait for a new WAL file to be archived
:param int|None archive_timeout: Timeout in seconds
"""
max_msg = ""
if archive_timeout:
max_msg = " (max: %s seconds)" % archive_timeout
initial_wals = dict()
if not wal_file:
wals = self.backup_manager.get_latest_archived_wals_info()
initial_wals = dict([(tli, wals[tli].name) for tli in wals])
if wal_file:
output.info(
"Waiting for the WAL file %s from server '%s'%s",
wal_file,
self.config.name,
max_msg,
)
else:
output.info(
"Waiting for a WAL file from server '%s' to be archived%s",
self.config.name,
max_msg,
)
# Wait for a new file until end_time or forever if no archive_timeout
end_time = None
if archive_timeout:
end_time = time.time() + archive_timeout
while not end_time or time.time() < end_time:
self.archive_wal(verbose=False)
# Finish if the closed wal file is in the archive.
if wal_file:
if os.path.exists(self.get_wal_full_path(wal_file)):
break
else:
# Check if any new file has been archived, on any timeline
wals = self.backup_manager.get_latest_archived_wals_info()
current_wals = dict([(tli, wals[tli].name) for tli in wals])
if current_wals != initial_wals:
break
# sleep a bit before retrying
time.sleep(0.1)
else:
if wal_file:
output.error(
"The WAL file %s has not been received in %s seconds",
wal_file,
archive_timeout,
)
else:
output.info(
"A WAL file has not been received in %s seconds", archive_timeout
)
def replication_status(self, target="all"):
"""
Implements the 'replication-status' command.
"""
if target == "hot-standby":
client_type = PostgreSQLConnection.STANDBY
elif target == "wal-streamer":
client_type = PostgreSQLConnection.WALSTREAMER
else:
client_type = PostgreSQLConnection.ANY_STREAMING_CLIENT
try:
standby_info = self.postgres.get_replication_stats(client_type)
if standby_info is None:
output.error("Unable to connect to server %s" % self.config.name)
else:
output.result(
"replication_status",
self.config.name,
target,
self.postgres.current_xlog_location,
standby_info,
)
except PostgresUnsupportedFeature as e:
output.info(" Requires PostgreSQL %s or higher", e)
except PostgresSuperuserRequired:
output.info(" Requires superuser rights")
def get_children_timelines(self, tli, forked_after=None):
"""
Get a list of the children of the passed timeline
:param int tli: Id of the timeline to check
:param str forked_after: XLog location after which the timeline
must have been created
:return List[xlog.HistoryFileData]: the list of timelines that
have the timeline with id 'tli' as parent
"""
comp_manager = self.backup_manager.compression_manager
if forked_after:
forked_after = xlog.parse_lsn(forked_after)
children = []
# Search all the history files after the passed timeline
children_tli = tli
while True:
children_tli += 1
history_path = os.path.join(
self.config.wals_directory, "%08X.history" % children_tli
)
# If the file doesn't exists, stop searching
if not os.path.exists(history_path):
break
# Create the WalFileInfo object using the file
wal_info = comp_manager.get_wal_file_info(history_path)
# Get content of the file. We need to pass a compressor manager
# here to handle an eventual compression of the history file
history_info = xlog.decode_history_file(
wal_info, self.backup_manager.compression_manager
)
# Save the history only if is reachable from this timeline.
for tinfo in history_info:
# The history file contains the full genealogy
# but we keep only the line with `tli` timeline as parent.
if tinfo.parent_tli != tli:
continue
# We need to return this history info only if this timeline
# has been forked after the passed LSN
if forked_after and tinfo.switchpoint < forked_after:
continue
children.append(tinfo)
return children
def check_backup(self, backup_info):
"""
Make sure that we have all the WAL files required
by a physical backup for consistency (from the
first to the last WAL file)
:param backup_info: the target backup
"""
output.debug(
"Checking backup %s of server %s", backup_info.backup_id, self.config.name
)
try:
# No need to check a backup which is not waiting for WALs.
# Doing that we could also mark as DONE backups which
# were previously FAILED due to copy errors
if backup_info.status == BackupInfo.FAILED:
output.error("The validity of a failed backup cannot be checked")
return
# Take care of the backup lock.
# Only one process can modify a backup a a time
with ServerBackupIdLock(
self.config.barman_lock_directory,
self.config.name,
backup_info.backup_id,
):
orig_status = backup_info.status
self.backup_manager.check_backup(backup_info)
if orig_status == backup_info.status:
output.debug(
"Check finished: the status of backup %s of server %s "
"remains %s",
backup_info.backup_id,
self.config.name,
backup_info.status,
)
else:
output.debug(
"Check finished: the status of backup %s of server %s "
"changed from %s to %s",
backup_info.backup_id,
self.config.name,
orig_status,
backup_info.status,
)
except LockFileBusy:
# If another process is holding the backup lock,
# notify the user and terminate.
# This is not an error condition because it happens when
# another process is validating the backup.
output.info(
"Another process is holding the lock for "
"backup %s of server %s." % (backup_info.backup_id, self.config.name)
)
return
except LockFilePermissionDenied as e:
# We cannot access the lockfile.
# warn the user and terminate
output.error("Permission denied, unable to access '%s'" % e)
return
def sync_status(self, last_wal=None, last_position=None):
"""
Return server status for sync purposes.
The method outputs JSON, containing:
* list of backups (with DONE status)
* server configuration
* last read position (in xlog.db)
* last read wal
* list of archived wal files
If last_wal is provided, the method will discard all the wall files
older than last_wal.
If last_position is provided the method will try to read
the xlog.db file using last_position as starting point.
If the wal file at last_position does not match last_wal, read from the
start and use last_wal as limit
:param str|None last_wal: last read wal
:param int|None last_position: last read position (in xlog.db)
"""
sync_status = {}
wals = []
# Get all the backups using default filter for
# get_available_backups method
# (BackupInfo.DONE)
backups = self.get_available_backups()
# Retrieve the first wal associated to a backup, it will be useful
# to filter our eventual WAL too old to be useful
first_useful_wal = None
if backups:
first_useful_wal = backups[sorted(backups.keys())[0]].begin_wal
# Read xlogdb file.
with self.xlogdb() as fxlogdb:
starting_point = self.set_sync_starting_point(
fxlogdb, last_wal, last_position
)
check_first_wal = starting_point == 0 and last_wal is not None
# The wal_info and line variables are used after the loop.
# We initialize them here to avoid errors with an empty xlogdb.
line = None
wal_info = None
for line in fxlogdb:
# Parse the line
wal_info = WalFileInfo.from_xlogdb_line(line)
# Check if user is requesting data that is not available.
# TODO: probably the check should be something like
# TODO: last_wal + 1 < wal_info.name
if check_first_wal:
if last_wal < wal_info.name:
raise SyncError(
"last_wal '%s' is older than the first"
" available wal '%s'" % (last_wal, wal_info.name)
)
else:
check_first_wal = False
# If last_wal is provided, discard any line older than last_wal
if last_wal:
if wal_info.name <= last_wal:
continue
# Else don't return any WAL older than first available backup
elif first_useful_wal and wal_info.name < first_useful_wal:
continue
wals.append(wal_info)
if wal_info is not None:
# Check if user is requesting data that is not available.
if last_wal is not None and last_wal > wal_info.name:
raise SyncError(
"last_wal '%s' is newer than the last available wal "
" '%s'" % (last_wal, wal_info.name)
)
# Set last_position with the current position - len(last_line)
# (returning the beginning of the last line)
sync_status["last_position"] = fxlogdb.tell() - len(line)
# Set the name of the last wal of the file
sync_status["last_name"] = wal_info.name
else:
# we started over
sync_status["last_position"] = 0
sync_status["last_name"] = ""
sync_status["backups"] = backups
sync_status["wals"] = wals
sync_status["version"] = barman.__version__
sync_status["config"] = self.config
json.dump(sync_status, sys.stdout, cls=BarmanEncoder, indent=4)
def sync_cron(self, keep_descriptors):
"""
Manage synchronisation operations between passive node and
master node.
The method recover information from the remote master
server, evaluate if synchronisation with the master is required
and spawn barman sub processes, syncing backups and WAL files
:param bool keep_descriptors: whether to keep subprocess descriptors
attached to this process.
"""
# Recover information from primary node
sync_wal_info = self.load_sync_wals_info()
# Use last_wal and last_position for the remote call to the
# master server
try:
remote_info = self.primary_node_info(
sync_wal_info.last_wal, sync_wal_info.last_position
)
except SyncError as exc:
output.error(
"Failed to retrieve the primary node status: %s" % force_str(exc)
)
return
# Perform backup synchronisation
if remote_info["backups"]:
# Get the list of backups that need to be synced
# with the local server
local_backup_list = self.get_available_backups()
# Subtract the list of the already
# synchronised backups from the remote backup lists,
# obtaining the list of backups still requiring synchronisation
sync_backup_list = set(remote_info["backups"]) - set(local_backup_list)
else:
# No backup to synchronisation required
output.info(
"No backup synchronisation required for server %s",
self.config.name,
log=False,
)
sync_backup_list = []
for backup_id in sorted(sync_backup_list):
# Check if this backup_id needs to be synchronized by spawning a
# sync-backup process.
# The same set of checks will be executed by the spawned process.
# This "double check" is necessary because we don't want the cron
# to spawn unnecessary processes.
try:
local_backup_info = self.get_backup(backup_id)
self.check_sync_required(backup_id, remote_info, local_backup_info)
except SyncError as e:
# It means that neither the local backup
# nor the remote one exist.
# This should not happen here.
output.exception("Unexpected state: %s", e)
break
except SyncToBeDeleted:
# The backup does not exist on primary server
# and is FAILED here.
# It must be removed by the sync-backup process.
pass
except SyncNothingToDo:
# It could mean that the local backup is in DONE state or
# that it is obsolete according to
# the local retention policies.
# In both cases, continue with the next backup.
continue
# Now that we are sure that a backup-sync subprocess is necessary,
# we need to acquire the backup lock, to be sure that
# there aren't other processes synchronising the backup.
# If cannot acquire the lock, another synchronisation process
# is running, so we give up.
try:
with ServerBackupSyncLock(
self.config.barman_lock_directory, self.config.name, backup_id
):
output.info(
"Starting copy of backup %s for server %s",
backup_id,
self.config.name,
)
except LockFileBusy:
output.info(
"A synchronisation process for backup %s"
" on server %s is already in progress",
backup_id,
self.config.name,
log=False,
)
# Stop processing this server
break
# Init a Barman sub-process object
sub_process = BarmanSubProcess(
subcommand="sync-backup",
config=barman.__config__.config_file,
args=[self.config.name, backup_id],
keep_descriptors=keep_descriptors,
)
# Launch the sub-process
sub_process.execute()
# Stop processing this server
break
# Perform WAL synchronisation
if remote_info["wals"]:
# We need to acquire a sync-wal lock, to be sure that
# there aren't other processes synchronising the WAL files.
# If cannot acquire the lock, another synchronisation process
# is running, so we give up.
try:
with ServerWalSyncLock(
self.config.barman_lock_directory,
self.config.name,
):
output.info(
"Started copy of WAL files for server %s", self.config.name
)
except LockFileBusy:
output.info(
"WAL synchronisation already running for server %s",
self.config.name,
log=False,
)
return
# Init a Barman sub-process object
sub_process = BarmanSubProcess(
subcommand="sync-wals",
config=barman.__config__.config_file,
args=[self.config.name],
keep_descriptors=keep_descriptors,
)
# Launch the sub-process
sub_process.execute()
else:
# no WAL synchronisation is required
output.info(
"No WAL synchronisation required for server %s",
self.config.name,
log=False,
)
def check_sync_required(self, backup_name, primary_info, local_backup_info):
"""
Check if it is necessary to sync a backup.
If the backup is present on the Primary node:
* if it does not exist locally: continue (synchronise it)
* if it exists and is DONE locally: raise SyncNothingToDo
(nothing to do)
* if it exists and is FAILED locally: continue (try to recover it)
If the backup is not present on the Primary node:
* if it does not exist locally: raise SyncError (wrong call)
* if it exists and is DONE locally: raise SyncNothingToDo
(nothing to do)
* if it exists and is FAILED locally: raise SyncToBeDeleted (remove it)
If a backup needs to be synchronised but it is obsolete according
to local retention policies, raise SyncNothingToDo,
else return to the caller.
:param str backup_name: str name of the backup to sync
:param dict primary_info: dict containing the Primary node status
:param barman.infofile.BackupInfo local_backup_info: BackupInfo object
representing the current backup state
:raise SyncError: There is an error in the user request
:raise SyncNothingToDo: Nothing to do for this request
:raise SyncToBeDeleted: Backup is not recoverable and must be deleted
"""
backups = primary_info["backups"]
# Backup not present on Primary node, and not present
# locally. Raise exception.
if backup_name not in backups and local_backup_info is None:
raise SyncError(
"Backup %s is absent on %s server" % (backup_name, self.config.name)
)
# Backup not present on Primary node, but is
# present locally with status FAILED: backup incomplete.
# Remove the backup and warn the user
if (
backup_name not in backups
and local_backup_info is not None
and local_backup_info.status == BackupInfo.FAILED
):
raise SyncToBeDeleted(
"Backup %s is absent on %s server and is incomplete locally"
% (backup_name, self.config.name)
)
# Backup not present on Primary node, but is
# present locally with status DONE. Sync complete, local only.
if (
backup_name not in backups
and local_backup_info is not None
and local_backup_info.status == BackupInfo.DONE
):
raise SyncNothingToDo(
"Backup %s is absent on %s server, but present locally "
"(local copy only)" % (backup_name, self.config.name)
)
# Backup present on Primary node, and present locally
# with status DONE. Sync complete.
if (
backup_name in backups
and local_backup_info is not None
and local_backup_info.status == BackupInfo.DONE
):
raise SyncNothingToDo(
"Backup %s is already synced with"
" %s server" % (backup_name, self.config.name)
)
# Retention Policy: if the local server has a Retention policy,
# check that the remote backup is not obsolete.
enforce_retention_policies = self.enforce_retention_policies
retention_policy_mode = self.config.retention_policy_mode
if enforce_retention_policies and retention_policy_mode == "auto":
# All the checks regarding retention policies are in
# this boolean method.
if self.is_backup_locally_obsolete(backup_name, backups):
# The remote backup is obsolete according to
# local retention policies.
# Nothing to do.
raise SyncNothingToDo(
"Remote backup %s/%s is obsolete for "
"local retention policies."
% (primary_info["config"]["name"], backup_name)
)
def load_sync_wals_info(self):
"""
Load the content of SYNC_WALS_INFO_FILE for the given server
:return collections.namedtuple: last read wal and position information
"""
sync_wals_info_file = os.path.join(
self.config.wals_directory, SYNC_WALS_INFO_FILE
)
if not os.path.exists(sync_wals_info_file):
return SyncWalInfo(None, None)
try:
with open(sync_wals_info_file) as f:
return SyncWalInfo._make(f.readline().split("\t"))
except (OSError, IOError) as e:
raise SyncError(
"Cannot open %s file for server %s: %s"
% (SYNC_WALS_INFO_FILE, self.config.name, e)
)
def primary_node_info(self, last_wal=None, last_position=None):
"""
Invoke sync-info directly on the specified primary node
The method issues a call to the sync-info method on the primary
node through an SSH connection
:param barman.server.Server self: the Server object
:param str|None last_wal: last read wal
:param int|None last_position: last read position (in xlog.db)
:raise SyncError: if the ssh command fails
"""
# First we need to check if the server is in passive mode
_logger.debug(
"primary sync-info(%s, %s, %s)", self.config.name, last_wal, last_position
)
if not self.passive_node:
raise SyncError("server %s is not passive" % self.config.name)
# Issue a call to 'barman sync-info' to the primary node,
# using primary_ssh_command option to establish an
# SSH connection.
remote_command = Command(
cmd=self.config.primary_ssh_command, shell=True, check=True, path=self.path
)
# We run it in a loop to retry when the master issues error.
while True:
try:
# Include the config path as an option if configured for this server
if self.config.forward_config_path:
base_cmd = "barman -c %s sync-info" % barman.__config__.config_file
else:
base_cmd = "barman sync-info"
# Build the command string
cmd_str = "%s %s" % (base_cmd, self.config.name)
# If necessary we add last_wal and last_position
# to the command string
if last_wal is not None:
cmd_str += " %s " % last_wal
if last_position is not None:
cmd_str += " %s " % last_position
# Then issue the command
remote_command(cmd_str)
# All good, exit the retry loop with 'break'
break
except CommandFailedException as exc:
# In case we requested synchronisation with a last WAL info,
# we try again requesting the full current status, but only if
# exit code is 1. A different exit code means that
# the error is not from Barman (i.e. ssh failure)
if exc.args[0]["ret"] == 1 and last_wal is not None:
last_wal = None
last_position = None
output.warning(
"sync-info is out of sync. "
"Self-recovery procedure started: "
"requesting full synchronisation from "
"primary server %s" % self.config.name
)
continue
# Wrap the CommandFailed exception with a SyncError
# for custom message and logging.
raise SyncError(
"sync-info execution on remote "
"primary server %s failed: %s"
% (self.config.name, exc.args[0]["err"])
)
# Save the result on disk
primary_info_file = os.path.join(
self.config.backup_directory, PRIMARY_INFO_FILE
)
# parse the json output
remote_info = json.loads(remote_command.out)
try:
# TODO: rename the method to make it public
# noinspection PyProtectedMember
self._make_directories()
# Save remote info to disk
# We do not use a LockFile here. Instead we write all data
# in a new file (adding '.tmp' extension) then we rename it
# replacing the old one.
# It works while the renaming is an atomic operation
# (this is a POSIX requirement)
primary_info_file_tmp = primary_info_file + ".tmp"
with open(primary_info_file_tmp, "w") as info_file:
info_file.write(remote_command.out)
os.rename(primary_info_file_tmp, primary_info_file)
except (OSError, IOError) as e:
# Wrap file access exceptions using SyncError
raise SyncError(
"Cannot open %s file for server %s: %s"
% (PRIMARY_INFO_FILE, self.config.name, e)
)
return remote_info
def is_backup_locally_obsolete(self, backup_name, remote_backups):
"""
Check if a remote backup is obsolete according with the local
retention policies.
:param barman.server.Server self: Server object
:param str backup_name: str name of the backup to sync
:param dict remote_backups: dict containing the Primary node status
:return bool: returns if the backup is obsolete or not
"""
# Get the local backups and add the remote backup info. This will
# simulate the situation after the copy of the remote backup.
local_backups = self.get_available_backups(BackupInfo.STATUS_NOT_EMPTY)
backup = remote_backups[backup_name]
local_backups[backup_name] = LocalBackupInfo.from_json(self, backup)
# Execute the local retention policy on the modified list of backups
report = self.config.retention_policy.report(source=local_backups)
# If the added backup is obsolete return true.
return report[backup_name] == BackupInfo.OBSOLETE
def sync_backup(self, backup_name):
"""
Method for the synchronisation of a backup from a primary server.
The Method checks that the server is passive, then if it is possible to
sync with the Primary. Acquires a lock at backup level
and copy the backup from the Primary node using rsync.
During the sync process the backup on the Passive node
is marked as SYNCING and if the sync fails
(due to network failure, user interruption...) it is marked as FAILED.
:param barman.server.Server self: the passive Server object to sync
:param str backup_name: the name of the backup to sync.
"""
_logger.debug("sync_backup(%s, %s)", self.config.name, backup_name)
if not self.passive_node:
raise SyncError("server %s is not passive" % self.config.name)
local_backup_info = self.get_backup(backup_name)
# Step 1. Parse data from Primary server.
_logger.info(
"Synchronising with server %s backup %s: step 1/3: "
"parse server information",
self.config.name,
backup_name,
)
try:
primary_info = self.load_primary_info()
self.check_sync_required(backup_name, primary_info, local_backup_info)
except SyncError as e:
# Invocation error: exit with return code 1
output.error("%s", e)
return
except SyncToBeDeleted as e:
# The required backup does not exist on primary,
# therefore it should be deleted also on passive node,
# as it's not in DONE status.
output.warning("%s, purging local backup", e)
self.delete_backup(local_backup_info)
return
except SyncNothingToDo as e:
# Nothing to do. Log as info level and exit
output.info("%s", e)
return
# If the backup is present on Primary node, and is not present at all
# locally or is present with FAILED status, execute sync.
# Retrieve info about the backup from PRIMARY_INFO_FILE
remote_backup_info = primary_info["backups"][backup_name]
remote_backup_dir = primary_info["config"]["basebackups_directory"]
# Try to acquire the backup lock, if the lock is not available abort
# the copy.
try:
with ServerBackupSyncLock(
self.config.barman_lock_directory, self.config.name, backup_name
):
try:
backup_manager = self.backup_manager
# Build a BackupInfo object
local_backup_info = LocalBackupInfo.from_json(
self, remote_backup_info
)
local_backup_info.set_attribute("status", BackupInfo.SYNCING)
local_backup_info.save()
backup_manager.backup_cache_add(local_backup_info)
# Activate incremental copy if requested
# Calculate the safe_horizon as the start time of the older
# backup involved in the copy
# NOTE: safe_horizon is a tz-aware timestamp because
# BackupInfo class ensures that property
reuse_mode = self.config.reuse_backup
safe_horizon = None
reuse_dir = None
if reuse_mode:
prev_backup = backup_manager.get_previous_backup(backup_name)
next_backup = backup_manager.get_next_backup(backup_name)
# If a newer backup is present, using it is preferable
# because that backup will remain valid longer
if next_backup:
safe_horizon = local_backup_info.begin_time
reuse_dir = next_backup.get_basebackup_directory()
elif prev_backup:
safe_horizon = prev_backup.begin_time
reuse_dir = prev_backup.get_basebackup_directory()
else:
reuse_mode = None
# Try to copy from the Primary node the backup using
# the copy controller.
copy_controller = RsyncCopyController(
ssh_command=self.config.primary_ssh_command,
network_compression=self.config.network_compression,
path=self.path,
reuse_backup=reuse_mode,
safe_horizon=safe_horizon,
retry_times=self.config.basebackup_retry_times,
retry_sleep=self.config.basebackup_retry_sleep,
workers=self.config.parallel_jobs,
)
copy_controller.add_directory(
"basebackup",
":%s/%s/" % (remote_backup_dir, backup_name),
local_backup_info.get_basebackup_directory(),
exclude_and_protect=["/backup.info", "/.backup.lock"],
bwlimit=self.config.bandwidth_limit,
reuse=reuse_dir,
item_class=RsyncCopyController.PGDATA_CLASS,
)
_logger.info(
"Synchronising with server %s backup %s: step 2/3: "
"file copy",
self.config.name,
backup_name,
)
copy_controller.copy()
# Save the backup state and exit
_logger.info(
"Synchronising with server %s backup %s: "
"step 3/3: finalise sync",
self.config.name,
backup_name,
)
local_backup_info.set_attribute("status", BackupInfo.DONE)
local_backup_info.save()
except CommandFailedException as e:
# Report rsync errors
msg = "failure syncing server %s backup %s: %s" % (
self.config.name,
backup_name,
e,
)
output.error(msg)
# Set the BackupInfo status to FAILED
local_backup_info.set_attribute("status", BackupInfo.FAILED)
local_backup_info.set_attribute("error", msg)
local_backup_info.save()
return
# Catch KeyboardInterrupt (Ctrl+c) and all the exceptions
except BaseException as e:
msg_lines = force_str(e).strip().splitlines()
if local_backup_info:
# Use only the first line of exception message
# in local_backup_info error field
local_backup_info.set_attribute("status", BackupInfo.FAILED)
# If the exception has no attached message
# use the raw type name
if not msg_lines:
msg_lines = [type(e).__name__]
local_backup_info.set_attribute(
"error",
"failure syncing server %s backup %s: %s"
% (self.config.name, backup_name, msg_lines[0]),
)
local_backup_info.save()
output.error(
"Backup failed syncing with %s: %s\n%s",
self.config.name,
msg_lines[0],
"\n".join(msg_lines[1:]),
)
except LockFileException:
output.error(
"Another synchronisation process for backup %s "
"of server %s is already running.",
backup_name,
self.config.name,
)
def sync_wals(self):
"""
Method for the synchronisation of WAL files on the passive node,
by copying them from the primary server.
The method checks if the server is passive, then tries to acquire
a sync-wal lock.
Recovers the id of the last locally archived WAL file from the
status file ($wals_directory/sync-wals.info).
Reads the primary.info file and parses it, then obtains the list of
WAL files that have not yet been synchronised with the master.
Rsync is used for file synchronisation with the primary server.
Once the copy is finished, acquires a lock on xlog.db, updates it
then releases the lock.
Before exiting, the method updates the last_wal
and last_position fields in the sync-wals.info file.
:param barman.server.Server self: the Server object to synchronise
"""
_logger.debug("sync_wals(%s)", self.config.name)
if not self.passive_node:
raise SyncError("server %s is not passive" % self.config.name)
# Try to acquire the sync-wal lock if the lock is not available,
# abort the sync-wal operation
try:
with ServerWalSyncLock(
self.config.barman_lock_directory,
self.config.name,
):
try:
# Need to load data from status files: primary.info
# and sync-wals.info
sync_wals_info = self.load_sync_wals_info()
primary_info = self.load_primary_info()
# We want to exit if the compression on master is different
# from the one on the local server
if primary_info["config"]["compression"] != self.config.compression:
raise SyncError(
"Compression method on server %s "
"(%s) does not match local "
"compression method (%s) "
% (
self.config.name,
primary_info["config"]["compression"],
self.config.compression,
)
)
# If the first WAL that needs to be copied is older
# than the begin WAL of the first locally available backup,
# synchronisation is skipped. This means that we need
# to copy a WAL file which won't be associated to any local
# backup. Consider the following scenarios:
#
# bw: indicates the begin WAL of the first backup
# sw: the first WAL to be sync-ed
#
# The following examples use truncated names for WAL files
# (e.g. 1 instead of 000000010000000000000001)
#
# Case 1: bw = 10, sw = 9 - SKIP and wait for backup
# Case 2: bw = 10, sw = 10 - SYNC
# Case 3: bw = 10, sw = 15 - SYNC
#
# Search for the first WAL file (skip history,
# backup and partial files)
first_remote_wal = None
for wal in primary_info["wals"]:
if xlog.is_wal_file(wal["name"]):
first_remote_wal = wal["name"]
break
first_backup_id = self.get_first_backup_id()
first_backup = (
self.get_backup(first_backup_id) if first_backup_id else None
)
# Also if there are not any backups on the local server
# no wal synchronisation is required
if not first_backup:
output.warning(
"No base backup for server %s" % self.config.name
)
return
if first_backup.begin_wal > first_remote_wal:
output.warning(
"Skipping WAL synchronisation for "
"server %s: no available local backup "
"for %s" % (self.config.name, first_remote_wal)
)
return
local_wals = []
wal_file_paths = []
for wal in primary_info["wals"]:
# filter all the WALs that are smaller
# or equal to the name of the latest synchronised WAL
if (
sync_wals_info.last_wal
and wal["name"] <= sync_wals_info.last_wal
):
continue
# Generate WalFileInfo Objects using remote WAL metas.
# This list will be used for the update of the xlog.db
wal_info_file = WalFileInfo(**wal)
local_wals.append(wal_info_file)
wal_file_paths.append(wal_info_file.relpath())
# Rsync Options:
# recursive: recursive copy of subdirectories
# perms: preserve permissions on synced files
# times: preserve modification timestamps during
# synchronisation
# protect-args: force rsync to preserve the integrity of
# rsync command arguments and filename.
# inplace: for inplace file substitution
# and update of files
rsync = Rsync(
args=[
"--recursive",
"--perms",
"--times",
"--protect-args",
"--inplace",
],
ssh=self.config.primary_ssh_command,
bwlimit=self.config.bandwidth_limit,
allowed_retval=(0,),
network_compression=self.config.network_compression,
path=self.path,
)
# Source and destination of the rsync operations
src = ":%s/" % primary_info["config"]["wals_directory"]
dest = "%s/" % self.config.wals_directory
# Perform the rsync copy using the list of relative paths
# obtained from the primary.info file
rsync.from_file_list(wal_file_paths, src, dest)
# If everything is synced without errors,
# update xlog.db using the list of WalFileInfo object
with self.xlogdb("a") as fxlogdb:
for wal_info in local_wals:
fxlogdb.write(wal_info.to_xlogdb_line())
# We need to update the sync-wals.info file with the latest
# synchronised WAL and the latest read position.
self.write_sync_wals_info_file(primary_info)
except CommandFailedException as e:
msg = "WAL synchronisation for server %s failed: %s" % (
self.config.name,
e,
)
output.error(msg)
return
except BaseException as e:
msg_lines = force_str(e).strip().splitlines()
# Use only the first line of exception message
# If the exception has no attached message
# use the raw type name
if not msg_lines:
msg_lines = [type(e).__name__]
output.error(
"WAL synchronisation for server %s failed with: %s\n%s",
self.config.name,
msg_lines[0],
"\n".join(msg_lines[1:]),
)
except LockFileException:
output.error(
"Another sync-wal operation is running for server %s ",
self.config.name,
)
@staticmethod
def set_sync_starting_point(xlogdb_file, last_wal, last_position):
"""
Check if the xlog.db file has changed between two requests
from the client and set the start point for reading the file
:param file xlogdb_file: an open and readable xlog.db file object
:param str|None last_wal: last read name
:param int|None last_position: last read position
:return int: the position has been set
"""
# If last_position is None start reading from the beginning of the file
position = int(last_position) if last_position is not None else 0
# Seek to required position
xlogdb_file.seek(position)
# Read 24 char (the size of a wal name)
wal_name = xlogdb_file.read(24)
# If the WAL name is the requested one start from last_position
if wal_name == last_wal:
# Return to the line start
xlogdb_file.seek(position)
return position
# If the file has been truncated, start over
xlogdb_file.seek(0)
return 0
def write_sync_wals_info_file(self, primary_info):
"""
Write the content of SYNC_WALS_INFO_FILE on disk
:param dict primary_info:
"""
try:
with open(
os.path.join(self.config.wals_directory, SYNC_WALS_INFO_FILE), "w"
) as syncfile:
syncfile.write(
"%s\t%s"
% (primary_info["last_name"], primary_info["last_position"])
)
except (OSError, IOError):
# Wrap file access exceptions using SyncError
raise SyncError(
"Unable to write %s file for server %s"
% (SYNC_WALS_INFO_FILE, self.config.name)
)
def load_primary_info(self):
"""
Load the content of PRIMARY_INFO_FILE for the given server
:return dict: primary server information
"""
primary_info_file = os.path.join(
self.config.backup_directory, PRIMARY_INFO_FILE
)
try:
with open(primary_info_file) as f:
return json.load(f)
except (OSError, IOError) as e:
# Wrap file access exceptions using SyncError
raise SyncError(
"Cannot open %s file for server %s: %s"
% (PRIMARY_INFO_FILE, self.config.name, e)
)
barman-2.18/barman/cloud_providers/ 0000755 0006212 0006212 00000000000 14172556766 015546 5 ustar 0000000 0000000 barman-2.18/barman/cloud_providers/azure_blob_storage.py 0000644 0006212 0006212 00000045641 14172556763 021777 0 ustar 0000000 0000000 # -*- coding: utf-8 -*-
# © Copyright EnterpriseDB UK Limited 2018-2022
#
# This file is part of Barman.
#
# Barman is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Barman is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Barman. If not, see
import logging
import os
import requests
from io import BytesIO, RawIOBase, SEEK_END
from barman.clients.cloud_compression import decompress_to_file
from barman.cloud import CloudInterface, CloudProviderError, DecompressingStreamingIO
try:
# Python 3.x
from urllib.parse import urlparse
except ImportError:
# Python 2.x
from urlparse import urlparse
try:
from azure.storage.blob import (
BlobPrefix,
ContainerClient,
PartialBatchErrorException,
)
from azure.core.exceptions import (
HttpResponseError,
ResourceNotFoundError,
ServiceRequestError,
)
except ImportError:
raise SystemExit("Missing required python module: azure-storage-blob")
# Domain for azure blob URIs
# See https://docs.microsoft.com/en-us/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata#resource-uri-syntax
AZURE_BLOB_STORAGE_DOMAIN = "blob.core.windows.net"
class StreamingBlobIO(RawIOBase):
"""
Wrap an azure-storage-blob StorageStreamDownloader in the IOBase API.
Inherits the IOBase defaults of seekable() -> False and writable() -> False.
"""
def __init__(self, blob):
self._chunks = blob.chunks()
self._current_chunk = BytesIO()
def readable(self):
return True
def read(self, n=1):
"""
Read at most n bytes from the stream.
Fetches new chunks from the StorageStreamDownloader until the requested
number of bytes have been read.
:param int n: Number of bytes to read from the stream
:return: Up to n bytes from the stream
:rtype: bytes
"""
n = None if n < 0 else n
blob_bytes = self._current_chunk.read(n)
bytes_count = len(blob_bytes)
try:
while bytes_count < n:
self._current_chunk = BytesIO(self._chunks.next())
new_blob_bytes = self._current_chunk.read(n - bytes_count)
bytes_count += len(new_blob_bytes)
blob_bytes += new_blob_bytes
except StopIteration:
pass
return blob_bytes
class AzureCloudInterface(CloudInterface):
# Azure block blob limitations
# https://docs.microsoft.com/en-us/rest/api/storageservices/understanding-block-blobs--append-blobs--and-page-blobs
MAX_CHUNKS_PER_FILE = 50000
# Minimum block size allowed in Azure Blob Storage is 64KB
MIN_CHUNK_SIZE = 64 << 10
# Azure Blob Storage permit a maximum of 4.75TB per file
# This is a hard limit, while our upload procedure can go over the specified
# MAX_ARCHIVE_SIZE - so we set a maximum of 1TB per file
MAX_ARCHIVE_SIZE = 1 << 40
# The size of each chunk in a single object upload when the size of the
# object exceeds max_single_put_size. We default to 2MB in order to
# allow the default max_concurrency of 8 to be achieved when uploading
# uncompressed WAL segments of the default 16MB size.
DEFAULT_MAX_BLOCK_SIZE = 2 << 20
# The maximum amount of concurrent chunks allowed in a single object upload
# where the size exceeds max_single_put_size. We default to 8 based on
# experiments with in-region and inter-region transfers within Azure.
DEFAULT_MAX_CONCURRENCY = 8
# The largest file size which will be uploaded in a single PUT request. This
# should be lower than the size of the compressed WAL segment in order to
# force the Azure client to use concurrent chunk upload for archiving WAL files.
DEFAULT_MAX_SINGLE_PUT_SIZE = 4 << 20
# The maximum size of the requests connection pool used by the Azure client
# to upload objects.
REQUESTS_POOL_MAXSIZE = 32
def __init__(
self,
url,
jobs=2,
encryption_scope=None,
credential=None,
tags=None,
max_block_size=DEFAULT_MAX_BLOCK_SIZE,
max_concurrency=DEFAULT_MAX_CONCURRENCY,
max_single_put_size=DEFAULT_MAX_SINGLE_PUT_SIZE,
):
"""
Create a new Azure Blob Storage interface given the supplied acccount url
:param str url: Full URL of the cloud destination/source
:param int jobs: How many sub-processes to use for asynchronous
uploading, defaults to 2.
"""
super(AzureCloudInterface, self).__init__(
url=url,
jobs=jobs,
tags=tags,
)
self.encryption_scope = encryption_scope
self.credential = credential
self.max_block_size = max_block_size
self.max_concurrency = max_concurrency
self.max_single_put_size = max_single_put_size
parsed_url = urlparse(url)
if parsed_url.netloc.endswith(AZURE_BLOB_STORAGE_DOMAIN):
# We have an Azure Storage URI so we use the following form:
# ://..core.windows.net/
# where is /.
# Note that although Azure supports an implicit root container, we require
# that the container is always included.
self.account_url = parsed_url.netloc
try:
self.bucket_name = parsed_url.path.split("/")[1]
except IndexError:
raise ValueError("azure blob storage URL %s is malformed" % url)
path = parsed_url.path.split("/")[2:]
else:
# We are dealing with emulated storage so we use the following form:
# http://://
logging.info("Using emulated storage URL: %s " % url)
if "AZURE_STORAGE_CONNECTION_STRING" not in os.environ:
raise ValueError(
"A connection string must be provided when using emulated storage"
)
try:
self.bucket_name = parsed_url.path.split("/")[2]
except IndexError:
raise ValueError("emulated storage URL %s is malformed" % url)
path = parsed_url.path.split("/")[3:]
self.path = "/".join(path)
self.bucket_exists = None
self._reinit_session()
def _reinit_session(self):
"""
Create a new session
"""
if self.credential:
# Any supplied credential takes precedence over the environment
credential = self.credential
elif "AZURE_STORAGE_CONNECTION_STRING" in os.environ:
logging.info("Authenticating to Azure with connection string")
self.container_client = ContainerClient.from_connection_string(
conn_str=os.getenv("AZURE_STORAGE_CONNECTION_STRING"),
container_name=self.bucket_name,
)
return
else:
if "AZURE_STORAGE_SAS_TOKEN" in os.environ:
logging.info("Authenticating to Azure with SAS token")
credential = os.getenv("AZURE_STORAGE_SAS_TOKEN")
elif "AZURE_STORAGE_KEY" in os.environ:
logging.info("Authenticating to Azure with shared key")
credential = os.getenv("AZURE_STORAGE_KEY")
else:
logging.info("Authenticating to Azure with default credentials")
# azure-identity is not part of azure-storage-blob so only import
# it if needed
try:
from azure.identity import DefaultAzureCredential
except ImportError:
raise SystemExit("Missing required python module: azure-identity")
credential = DefaultAzureCredential()
session = requests.Session()
adapter = requests.adapters.HTTPAdapter(pool_maxsize=self.REQUESTS_POOL_MAXSIZE)
session.mount("https://", adapter)
self.container_client = ContainerClient(
account_url=self.account_url,
container_name=self.bucket_name,
credential=credential,
max_single_put_size=self.max_single_put_size,
max_block_size=self.max_block_size,
session=session,
)
@property
def _extra_upload_args(self):
optional_args = {}
if self.encryption_scope:
optional_args["encryption_scope"] = self.encryption_scope
return optional_args
def test_connectivity(self):
"""
Test Azure connectivity by trying to access a container
"""
try:
# We are not even interested in the existence of the bucket,
# we just want to see if Azure blob service is reachable.
self.bucket_exists = self._check_bucket_existence()
return True
except (HttpResponseError, ServiceRequestError) as exc:
logging.error("Can't connect to cloud provider: %s", exc)
return False
def _check_bucket_existence(self):
"""
Chck Azure Blob Storage for the target container
Although there is an `exists` function it cannot be called by container-level
shared access tokens. We therefore check for existence by calling list_blobs
on the container.
:return: True if the container exists, False otherwise
:rtype: bool
"""
try:
self.container_client.list_blobs().next()
except ResourceNotFoundError:
return False
except StopIteration:
# The bucket is empty but it does exist
pass
return True
def _create_bucket(self):
"""
Create the container in cloud storage
"""
# By default public access is disabled for newly created containers.
# Unlike S3 there is no concept of regions for containers (this is at
# the storage account level in Azure)
self.container_client.create_container()
def _walk_blob_tree(self, obj, ignore=None):
"""
Walk a blob tree in a directory manner and return a list of directories
and files.
:param ItemPaged[BlobProperties] obj: Iterable response of BlobProperties
obtained from ContainerClient.walk_blobs
:param str|None ignore: An entry to be excluded from the returned list,
typically the top level prefix
:return: List of objects and directories in the tree
:rtype: List[str]
"""
if obj.name != ignore:
yield obj.name
if isinstance(obj, BlobPrefix):
# We are a prefix and not a leaf so iterate children
for child in obj:
for v in self._walk_blob_tree(child):
yield v
def list_bucket(self, prefix="", delimiter="/"):
"""
List bucket content in a directory manner
:param str prefix:
:param str delimiter:
:return: List of objects and dirs right under the prefix
:rtype: List[str]
"""
res = self.container_client.walk_blobs(
name_starts_with=prefix, delimiter=delimiter
)
return self._walk_blob_tree(res, ignore=prefix)
def download_file(self, key, dest_path, decompress=None):
"""
Download a file from Azure Blob Storage
:param str key: The key to download
:param str dest_path: Where to put the destination file
:param str|None decompress: Compression scheme to use for decompression
"""
obj = self.container_client.download_blob(key)
with open(dest_path, "wb") as dest_file:
if not decompress:
obj.download_to_stream(dest_file)
return
blob = StreamingBlobIO(obj)
decompress_to_file(blob, dest_file, decompress)
def remote_open(self, key, decompressor=None):
"""
Open a remote Azure Blob Storage object and return a readable stream
:param str key: The key identifying the object to open
:param barman.clients.cloud_compression.ChunkedCompressor decompressor:
A ChunkedCompressor object which will be used to decompress chunks of bytes
as they are read from the stream
:return: A file-like object from which the stream can be read or None if
the key does not exist
"""
try:
obj = self.container_client.download_blob(key)
resp = StreamingBlobIO(obj)
if decompressor:
return DecompressingStreamingIO(resp, decompressor)
else:
return resp
except ResourceNotFoundError:
return None
def upload_fileobj(
self,
fileobj,
key,
override_tags=None,
):
"""
Synchronously upload the content of a file-like object to a cloud key
:param fileobj IOBase: File-like object to upload
:param str key: The key to identify the uploaded object
:param List[tuple] override_tags: List of tags as k,v tuples to be added to the
uploaded object
"""
# Find length of the file so we can pass it to the Azure client
fileobj.seek(0, SEEK_END)
length = fileobj.tell()
fileobj.seek(0)
extra_args = self._extra_upload_args.copy()
tags = override_tags or self.tags
if tags is not None:
extra_args["tags"] = dict(tags)
self.container_client.upload_blob(
name=key,
data=fileobj,
overwrite=True,
length=length,
max_concurrency=self.max_concurrency,
**extra_args
)
def create_multipart_upload(self, key):
"""No-op method because Azure has no concept of multipart uploads
Instead of multipart upload, blob blocks are staged and then committed.
However this does not require anything to be created up front.
This method therefore does nothing.
"""
pass
def _upload_part(self, upload_metadata, key, body, part_number):
"""
Upload a single block of this block blob.
Uses the supplied part number to generate the block ID and returns it
as the "PartNumber" in the part metadata.
:param dict upload_metadata: Provider-specific metadata about the upload
(not used in Azure)
:param str key: The key to use in the cloud service
:param object body: A stream-like object to upload
:param int part_number: Part number, starting from 1
:return: The part metadata
:rtype: dict[str, None|str]
"""
# Block IDs must be the same length for all bocks in the blob
# and no greater than 64 characters. Given there is a limit of
# 50000 blocks per blob we zero-pad the part_number to five
# places.
block_id = str(part_number).zfill(5)
blob_client = self.container_client.get_blob_client(key)
blob_client.stage_block(block_id, body, **self._extra_upload_args)
return {"PartNumber": block_id}
def _complete_multipart_upload(self, upload_metadata, key, parts):
"""
Finish a "multipart upload" by committing all blocks in the blob.
:param dict upload_metadata: Provider-specific metadata about the upload
(not used in Azure)
:param str key: The key to use in the cloud service
:param parts: The list of block IDs for the blocks which compose this blob
"""
blob_client = self.container_client.get_blob_client(key)
block_list = [part["PartNumber"] for part in parts]
extra_args = self._extra_upload_args.copy()
if self.tags is not None:
extra_args["tags"] = dict(self.tags)
blob_client.commit_block_list(block_list, **extra_args)
def _abort_multipart_upload(self, upload_metadata, key):
"""
Abort the upload of a block blob
The objective of this method is to clean up any dangling resources - in
this case those resources are uncommitted blocks.
:param dict upload_metadata: Provider-specific metadata about the upload
(not used in Azure)
:param str key: The key to use in the cloud service
"""
# Ideally we would clean up uncommitted blocks at this point
# however there is no way of doing that.
# Uncommitted blocks will be discarded after 7 days or when
# the blob is committed (if they're not included in the commit).
# We therefore create an empty blob (thereby discarding all uploaded
# blocks for that blob) and then delete it.
blob_client = self.container_client.get_blob_client(key)
blob_client.commit_block_list([], **self._extra_upload_args)
blob_client.delete_blob()
def delete_objects(self, paths):
"""
Delete the objects at the specified paths
:param List[str] paths:
"""
try:
# If paths is empty because the files have already been deleted then
# delete_blobs will return successfully so we just call it with whatever
# we were given
responses = self.container_client.delete_blobs(*paths)
except PartialBatchErrorException as exc:
# Although the docs imply any errors will be returned in the response
# object, in practice a PartialBatchErrorException is raised which contains
# the response objects in its `parts` attribute.
# We therefore set responses to reference the response in the exception and
# treat it the same way we would a regular response.
logging.warning(
"PartialBatchErrorException received from Azure: %s" % exc.message
)
responses = exc.parts
# resp is an iterator of HttpResponse objects so we check the status codes
# which should all be 202 if successful
errors = False
for resp in responses:
if resp.status_code == 404:
logging.warning(
"Deletion of object %s failed because it could not be found"
% resp.request.url
)
elif resp.status_code != 202:
errors = True
logging.error(
'Deletion of object %s failed with error code: "%s"'
% (resp.request.url, resp.status_code)
)
if errors:
raise CloudProviderError(
"Error from cloud provider while deleting objects - "
"please check the Barman logs"
)
barman-2.18/barman/cloud_providers/__init__.py 0000644 0006212 0006212 00000007133 14172556763 017660 0 ustar 0000000 0000000 # -*- coding: utf-8 -*-
# © Copyright EnterpriseDB UK Limited 2018-2022
#
# This file is part of Barman.
#
# Barman is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Barman is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Barman. If not, see
from barman.exceptions import BarmanException
class CloudProviderUnsupported(BarmanException):
"""
Exception raised when an unsupported cloud provider is requested
"""
class CloudProviderOptionUnsupported(BarmanException):
"""
Exception raised when a supported cloud provider is given an unsupported
option
"""
def _update_kwargs(kwargs, config, args):
"""
Helper which adds the attributes of config specified in args to the supplied
kwargs dict if they exist.
"""
for arg in args:
if arg in config:
kwargs[arg] = getattr(config, arg)
def _make_s3_cloud_interface(config, cloud_interface_kwargs):
from barman.cloud_providers.aws_s3 import S3CloudInterface
cloud_interface_kwargs.update(
{
"profile_name": config.profile,
"endpoint_url": config.endpoint_url,
}
)
if "encryption" in config:
cloud_interface_kwargs["encryption"] = config.encryption
return S3CloudInterface(**cloud_interface_kwargs)
def _make_azure_cloud_interface(config, cloud_interface_kwargs):
from barman.cloud_providers.azure_blob_storage import AzureCloudInterface
_update_kwargs(
cloud_interface_kwargs,
config,
(
"encryption_scope",
"max_block_size",
"max_concurrency",
"max_single_put_size",
),
)
if "credential" in config and config.credential is not None:
try:
from azure.identity import AzureCliCredential, ManagedIdentityCredential
except ImportError:
raise SystemExit("Missing required python module: azure-identity")
supported_credentials = {
"azure-cli": AzureCliCredential,
"managed-identity": ManagedIdentityCredential,
}
try:
cloud_interface_kwargs["credential"] = supported_credentials[
config.credential
]()
except KeyError:
raise CloudProviderOptionUnsupported(
"Unsupported credential: %s" % config.credential
)
return AzureCloudInterface(**cloud_interface_kwargs)
def get_cloud_interface(config):
"""
Create a CloudInterface for the specified cloud_provider
:returns: A CloudInterface for the specified cloud_provider
:rtype: CloudInterface
"""
cloud_interface_kwargs = {
"url": config.source_url if "source_url" in config else config.destination_url
}
_update_kwargs(cloud_interface_kwargs, config, ("jobs", "tags"))
if config.cloud_provider == "aws-s3":
return _make_s3_cloud_interface(config, cloud_interface_kwargs)
elif config.cloud_provider == "azure-blob-storage":
return _make_azure_cloud_interface(config, cloud_interface_kwargs)
else:
raise CloudProviderUnsupported(
"Unsupported cloud provider: %s" % config.cloud_provider
)
barman-2.18/barman/cloud_providers/aws_s3.py 0000644 0006212 0006212 00000033460 14172556763 017322 0 ustar 0000000 0000000 # -*- coding: utf-8 -*-
# © Copyright EnterpriseDB UK Limited 2018-2022
#
# This file is part of Barman.
#
# Barman is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Barman is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Barman. If not, see
import logging
import shutil
from io import RawIOBase
from barman.clients.cloud_compression import decompress_to_file
from barman.cloud import CloudInterface, CloudProviderError, DecompressingStreamingIO
try:
# Python 3.x
from urllib.parse import urlencode, urlparse
except ImportError:
# Python 2.x
from urlparse import urlparse
from urllib import urlencode
try:
import boto3
from botocore.exceptions import ClientError, EndpointConnectionError
except ImportError:
raise SystemExit("Missing required python module: boto3")
class StreamingBodyIO(RawIOBase):
"""
Wrap a boto StreamingBody in the IOBase API.
"""
def __init__(self, body):
self.body = body
def readable(self):
return True
def read(self, n=-1):
n = None if n < 0 else n
return self.body.read(n)
class S3CloudInterface(CloudInterface):
# S3 multipart upload limitations
# http://docs.aws.amazon.com/AmazonS3/latest/API/mpUploadUploadPart.html
MAX_CHUNKS_PER_FILE = 10000
MIN_CHUNK_SIZE = 5 << 20
# S3 permit a maximum of 5TB per file
# https://docs.aws.amazon.com/AmazonS3/latest/dev/UploadingObjects.html
# This is a hard limit, while our upload procedure can go over the specified
# MAX_ARCHIVE_SIZE - so we set a maximum of 1TB per file
MAX_ARCHIVE_SIZE = 1 << 40
def __getstate__(self):
state = self.__dict__.copy()
# Remove boto3 client reference from the state as it cannot be pickled
# in Python >= 3.8 and multiprocessing will pickle the object when the
# worker processes are created.
# The worker processes create their own boto3 sessions so do not need
# the boto3 session from the parent process.
del state["s3"]
return state
def __setstate__(self, state):
self.__dict__.update(state)
def __init__(
self,
url,
encryption=None,
jobs=2,
profile_name=None,
endpoint_url=None,
tags=None,
):
"""
Create a new S3 interface given the S3 destination url and the profile
name
:param str url: Full URL of the cloud destination/source
:param str|None encryption: Encryption type string
:param int jobs: How many sub-processes to use for asynchronous
uploading, defaults to 2.
:param str profile_name: Amazon auth profile identifier
:param str endpoint_url: override default endpoint detection strategy
with this one
"""
super(S3CloudInterface, self).__init__(
url=url,
jobs=jobs,
tags=tags,
)
self.profile_name = profile_name
self.encryption = encryption
self.endpoint_url = endpoint_url
# Extract information from the destination URL
parsed_url = urlparse(url)
# If netloc is not present, the s3 url is badly formatted.
if parsed_url.netloc == "" or parsed_url.scheme != "s3":
raise ValueError("Invalid s3 URL address: %s" % url)
self.bucket_name = parsed_url.netloc
self.bucket_exists = None
self.path = parsed_url.path.lstrip("/")
# Build a session, so we can extract the correct resource
self._reinit_session()
def _reinit_session(self):
"""
Create a new session
"""
session = boto3.Session(profile_name=self.profile_name)
self.s3 = session.resource("s3", endpoint_url=self.endpoint_url)
@property
def _extra_upload_args(self):
"""
Return a dict containing ExtraArgs to be passed to certain boto3 calls
Because some boto3 calls accept `ExtraArgs: {}` and others do not, we
return a nexted dict which can be expanded with `**` in the boto3 call.
"""
additional_args = {}
if self.encryption:
additional_args["ServerSideEncryption"] = self.encryption
return additional_args
def test_connectivity(self):
"""
Test AWS connectivity by trying to access a bucket
"""
try:
# We are not even interested in the existence of the bucket,
# we just want to try if aws is reachable
self.bucket_exists = self._check_bucket_existence()
return True
except EndpointConnectionError as exc:
logging.error("Can't connect to cloud provider: %s", exc)
return False
def _check_bucket_existence(self):
"""
Check cloud storage for the target bucket
:return: True if the bucket exists, False otherwise
:rtype: bool
"""
try:
# Search the bucket on s3
self.s3.meta.client.head_bucket(Bucket=self.bucket_name)
return True
except ClientError as exc:
# If a client error is thrown, then check the error code.
# If code was 404, then the bucket does not exist
error_code = exc.response["Error"]["Code"]
if error_code == "404":
return False
# Otherwise there is nothing else to do than re-raise the original
# exception
raise
def _create_bucket(self):
"""
Create the bucket in cloud storage
"""
# Get the current region from client.
# Do not use session.region_name here because it may be None
region = self.s3.meta.client.meta.region_name
logging.info(
"Bucket '%s' does not exist, creating it on region '%s'",
self.bucket_name,
region,
)
create_bucket_config = {
"ACL": "private",
}
# The location constraint is required during bucket creation
# for all regions outside of us-east-1. This constraint cannot
# be specified in us-east-1; specifying it in this region
# results in a failure, so we will only
# add it if we are deploying outside of us-east-1.
# See https://github.com/boto/boto3/issues/125
if region != "us-east-1":
create_bucket_config["CreateBucketConfiguration"] = {
"LocationConstraint": region,
}
self.s3.Bucket(self.bucket_name).create(**create_bucket_config)
def list_bucket(self, prefix="", delimiter="/"):
"""
List bucket content in a directory manner
:param str prefix:
:param str delimiter:
:return: List of objects and dirs right under the prefix
:rtype: List[str]
"""
if prefix.startswith(delimiter):
prefix = prefix.lstrip(delimiter)
res = self.s3.meta.client.list_objects_v2(
Bucket=self.bucket_name, Prefix=prefix, Delimiter=delimiter
)
# List "folders"
keys = res.get("CommonPrefixes")
if keys is not None:
for k in keys:
yield k.get("Prefix")
# List "files"
objects = res.get("Contents")
if objects is not None:
for o in objects:
yield o.get("Key")
def download_file(self, key, dest_path, decompress):
"""
Download a file from S3
:param str key: The S3 key to download
:param str dest_path: Where to put the destination file
:param bool decompress: Whenever to decompress this file or not
"""
# Open the remote file
obj = self.s3.Object(self.bucket_name, key)
remote_file = obj.get()["Body"]
# Write the dest file in binary mode
with open(dest_path, "wb") as dest_file:
# If the file is not compressed, just copy its content
if not decompress:
shutil.copyfileobj(remote_file, dest_file)
return
decompress_to_file(remote_file, dest_file, decompress)
def remote_open(self, key, decompressor=None):
"""
Open a remote S3 object and returns a readable stream
:param str key: The key identifying the object to open
:param barman.clients.cloud_compression.ChunkedCompressor decompressor:
A ChunkedCompressor object which will be used to decompress chunks of bytes
as they are read from the stream
:return: A file-like object from which the stream can be read or None if
the key does not exist
"""
try:
obj = self.s3.Object(self.bucket_name, key)
resp = StreamingBodyIO(obj.get()["Body"])
if decompressor:
return DecompressingStreamingIO(resp, decompressor)
else:
return resp
except ClientError as exc:
error_code = exc.response["Error"]["Code"]
if error_code == "NoSuchKey":
return None
else:
raise
def upload_fileobj(self, fileobj, key, override_tags=None):
"""
Synchronously upload the content of a file-like object to a cloud key
:param fileobj IOBase: File-like object to upload
:param str key: The key to identify the uploaded object
:param List[tuple] override_tags: List of k,v tuples which should override any
tags already defined in the cloud interface
"""
extra_args = self._extra_upload_args.copy()
tags = override_tags or self.tags
if tags is not None:
extra_args["Tagging"] = urlencode(tags)
self.s3.meta.client.upload_fileobj(
Fileobj=fileobj, Bucket=self.bucket_name, Key=key, ExtraArgs=extra_args
)
def create_multipart_upload(self, key):
"""
Create a new multipart upload
:param key: The key to use in the cloud service
:return: The multipart upload handle
:rtype: dict[str, str]
"""
extra_args = self._extra_upload_args.copy()
if self.tags is not None:
extra_args["Tagging"] = urlencode(self.tags)
return self.s3.meta.client.create_multipart_upload(
Bucket=self.bucket_name, Key=key, **extra_args
)
def _upload_part(self, upload_metadata, key, body, part_number):
"""
Upload a part into this multipart upload
:param dict upload_metadata: The multipart upload handle
:param str key: The key to use in the cloud service
:param object body: A stream-like object to upload
:param int part_number: Part number, starting from 1
:return: The part handle
:rtype: dict[str, None|str]
"""
part = self.s3.meta.client.upload_part(
Body=body,
Bucket=self.bucket_name,
Key=key,
UploadId=upload_metadata["UploadId"],
PartNumber=part_number,
)
return {
"PartNumber": part_number,
"ETag": part["ETag"],
}
def _complete_multipart_upload(self, upload_metadata, key, parts):
"""
Finish a certain multipart upload
:param dict upload_metadata: The multipart upload handle
:param str key: The key to use in the cloud service
:param parts: The list of parts composing the multipart upload
"""
self.s3.meta.client.complete_multipart_upload(
Bucket=self.bucket_name,
Key=key,
UploadId=upload_metadata["UploadId"],
MultipartUpload={"Parts": parts},
)
def _abort_multipart_upload(self, upload_metadata, key):
"""
Abort a certain multipart upload
:param dict upload_metadata: The multipart upload handle
:param str key: The key to use in the cloud service
"""
self.s3.meta.client.abort_multipart_upload(
Bucket=self.bucket_name, Key=key, UploadId=upload_metadata["UploadId"]
)
def delete_objects(self, paths):
"""
Delete the objects at the specified paths
:param List[str] paths:
"""
# Explicitly check if we are being asked to delete nothing at all and if
# so return without error.
if len(paths) == 0:
return
# S3 bulk deletion is limited to batches of 1000 keys
batch_size = 1000
try:
# If xrange exists then we are on python 2 so we need to use it
range_fun = xrange
except NameError:
# Otherwise just use range
range_fun = range
errors = False
for i in range_fun(0, len(paths), batch_size):
resp = self.s3.meta.client.delete_objects(
Bucket=self.bucket_name,
Delete={
"Objects": [{"Key": path} for path in paths[i : i + batch_size]],
"Quiet": True,
},
)
if "Errors" in resp:
errors = True
for error_dict in resp["Errors"]:
logging.error(
'Deletion of object %s failed with error code: "%s", message: "%s"'
% (error_dict["Key"], error_dict["Code"], error_dict["Message"])
)
if errors:
raise CloudProviderError(
"Error from cloud provider while deleting objects - "
"please check the Barman logs"
)
barman-2.18/barman/diagnose.py 0000644 0006212 0006212 00000006726 14172556763 014516 0 ustar 0000000 0000000 # -*- coding: utf-8 -*-
# © Copyright EnterpriseDB UK Limited 2011-2022
#
# This file is part of Barman.
#
# Barman is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Barman is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Barman. If not, see .
"""
This module represents the barman diagnostic tool.
"""
import datetime
import json
import logging
import barman
from barman import fs, output
from barman.backup import BackupInfo
from barman.exceptions import CommandFailedException, FsOperationFailed
from barman.utils import BarmanEncoder
_logger = logging.getLogger(__name__)
def exec_diagnose(servers, errors_list):
"""
Diagnostic command: gathers information from backup server
and from all the configured servers.
Gathered information should be used for support and problems detection
:param dict(str,barman.server.Server) servers: list of configured servers
:param list errors_list: list of global errors
"""
# global section. info about barman server
diagnosis = {"global": {}, "servers": {}}
# barman global config
diagnosis["global"]["config"] = dict(barman.__config__._global_config)
diagnosis["global"]["config"]["errors_list"] = errors_list
try:
command = fs.UnixLocalCommand()
# basic system info
diagnosis["global"]["system_info"] = command.get_system_info()
except CommandFailedException as e:
diagnosis["global"]["system_info"] = {"error": repr(e)}
diagnosis["global"]["system_info"]["barman_ver"] = barman.__version__
diagnosis["global"]["system_info"]["timestamp"] = datetime.datetime.now()
# per server section
for name in sorted(servers):
server = servers[name]
if server is None:
output.error("Unknown server '%s'" % name)
continue
# server configuration
diagnosis["servers"][name] = {}
diagnosis["servers"][name]["config"] = vars(server.config)
if "config" in diagnosis["servers"][name]["config"]:
del diagnosis["servers"][name]["config"]["config"]
# server system info
if server.config.ssh_command:
try:
command = fs.UnixRemoteCommand(
ssh_command=server.config.ssh_command, path=server.path
)
diagnosis["servers"][name]["system_info"] = command.get_system_info()
except FsOperationFailed:
pass
# barman status information for the server
diagnosis["servers"][name]["status"] = server.get_remote_status()
# backup list
backups = server.get_available_backups(BackupInfo.STATUS_ALL)
diagnosis["servers"][name]["backups"] = backups
# wal status
diagnosis["servers"][name]["wals"] = {
"last_archived_wal_per_timeline": server.backup_manager.get_latest_archived_wals_info(),
}
# Release any PostgreSQL resource
server.close()
output.info(
json.dumps(diagnosis, cls=BarmanEncoder, indent=4, sort_keys=True), log=False
)
barman-2.18/barman/cli.py 0000644 0006212 0006212 00000167372 14172556763 013501 0 ustar 0000000 0000000 # -*- coding: utf-8 -*-
# © Copyright EnterpriseDB UK Limited 2011-2022
#
# This file is part of Barman.
#
# Barman is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Barman is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Barman. If not, see .
"""
This module implements the interface with the command line and the logger.
"""
import json
import logging
import os
import sys
from argparse import SUPPRESS, ArgumentTypeError, ArgumentParser, HelpFormatter
if sys.version_info.major < 3:
from argparse import Action, _SubParsersAction, _ActionsContainer
import argcomplete
from collections import OrderedDict
from contextlib import closing
import barman.config
import barman.diagnose
from barman import output
from barman.annotations import KeepManager
from barman.config import RecoveryOptions
from barman.exceptions import (
BadXlogSegmentName,
RecoveryException,
SyncError,
WalArchiveContentError,
)
from barman.infofile import BackupInfo, WalFileInfo
from barman.server import Server
from barman.utils import (
BarmanEncoder,
check_non_negative,
check_positive,
configure_logging,
drop_privileges,
force_str,
get_log_levels,
parse_log_level,
SHA256,
)
from barman.xlog import check_archive_usable
from barman.backup_manifest import BackupManifest
from barman.storage.local_file_manager import LocalFileManager
_logger = logging.getLogger(__name__)
# Support aliases for argparse in python2.
# Derived from https://gist.github.com/sampsyo/471779 and based on the
# initial patchset for CPython for supporting aliases in argparse.
# Licensed under CC0 1.0
if sys.version_info.major < 3:
class AliasedSubParsersAction(_SubParsersAction):
old_init = staticmethod(_ActionsContainer.__init__)
@staticmethod
def _containerInit(
self, description, prefix_chars, argument_default, conflict_handler
):
AliasedSubParsersAction.old_init(
self, description, prefix_chars, argument_default, conflict_handler
)
self.register("action", "parsers", AliasedSubParsersAction)
class _AliasedPseudoAction(Action):
def __init__(self, name, aliases, help):
dest = name
if aliases:
dest += " (%s)" % ",".join(aliases)
sup = super(AliasedSubParsersAction._AliasedPseudoAction, self)
sup.__init__(option_strings=[], dest=dest, help=help)
def add_parser(self, name, **kwargs):
aliases = kwargs.pop("aliases", [])
parser = super(AliasedSubParsersAction, self).add_parser(name, **kwargs)
# Make the aliases work.
for alias in aliases:
self._name_parser_map[alias] = parser
# Make the help text reflect them, first removing old help entry.
if "help" in kwargs:
help_text = kwargs.pop("help")
self._choices_actions.pop()
pseudo_action = self._AliasedPseudoAction(name, aliases, help_text)
self._choices_actions.append(pseudo_action)
return parser
# override argparse to register new subparser action by default
_ActionsContainer.__init__ = AliasedSubParsersAction._containerInit
class OrderedHelpFormatter(HelpFormatter):
def _format_usage(self, usage, actions, groups, prefix):
for action in actions:
if not action.option_strings:
action.choices = OrderedDict(sorted(action.choices.items()))
return super(OrderedHelpFormatter, self)._format_usage(
usage, actions, groups, prefix
)
p = ArgumentParser(
epilog="Barman by EnterpriseDB (www.enterprisedb.com)",
formatter_class=OrderedHelpFormatter,
)
p.add_argument(
"-v",
"--version",
action="version",
version="%s\n\nBarman by EnterpriseDB (www.enterprisedb.com)" % barman.__version__,
)
p.add_argument(
"-c",
"--config",
help="uses a configuration file "
"(defaults: %s)" % ", ".join(barman.config.Config.CONFIG_FILES),
default=SUPPRESS,
)
p.add_argument(
"--color",
"--colour",
help="Whether to use colors in the output",
choices=["never", "always", "auto"],
default="auto",
)
p.add_argument(
"--log-level",
help="Override the default log level",
choices=list(get_log_levels()),
default=SUPPRESS,
)
p.add_argument("-q", "--quiet", help="be quiet", action="store_true")
p.add_argument("-d", "--debug", help="debug output", action="store_true")
p.add_argument(
"-f",
"--format",
help="output format",
choices=output.AVAILABLE_WRITERS.keys(),
default=output.DEFAULT_WRITER,
)
subparsers = p.add_subparsers(dest="command")
def argument(*name_or_flags, **kwargs):
"""Convenience function to properly format arguments to pass to the
command decorator.
"""
# Remove the completer keyword argument from the dictionary
completer = kwargs.pop("completer", None)
return (list(name_or_flags), completer, kwargs)
def command(args=None, parent=subparsers, cmd_aliases=None):
"""Decorator to define a new subcommand in a sanity-preserving way.
The function will be stored in the ``func`` variable when the parser
parses arguments so that it can be called directly like so::
args = cli.parse_args()
args.func(args)
Usage example::
@command([argument("-d", help="Enable debug mode", action="store_true")])
def command(args):
print(args)
Then on the command line::
$ python cli.py command -d
"""
if args is None:
args = []
if cmd_aliases is None:
cmd_aliases = []
def decorator(func):
parser = parent.add_parser(
func.__name__.replace("_", "-"),
description=func.__doc__,
help=func.__doc__,
aliases=cmd_aliases,
)
parent._choices_actions = sorted(parent._choices_actions, key=lambda x: x.dest)
for arg in args:
if arg[1]:
parser.add_argument(*arg[0], **arg[2]).completer = arg[1]
else:
parser.add_argument(*arg[0], **arg[2])
parser.set_defaults(func=func)
return func
return decorator
@command()
def help(args=None):
"""
show this help message and exit
"""
p.print_help()
def check_target_action(value):
"""
Check the target action option
:param value: str containing the value to check
"""
if value is None:
return None
if value in ("pause", "shutdown", "promote"):
return value
raise ArgumentTypeError("'%s' is not a valid recovery target action" % value)
@command(
[argument("--minimal", help="machine readable output", action="store_true")],
cmd_aliases=["list-server"],
)
def list_servers(args):
"""
List available servers, with useful information
"""
# Get every server, both inactive and temporarily disabled
servers = get_server_list()
for name in sorted(servers):
server = servers[name]
# Exception: manage_server_command is not invoked here
# Normally you would call manage_server_command to check if the
# server is None and to report inactive and disabled servers, but here
# we want all servers and the server cannot be None
output.init("list_server", name, minimal=args.minimal)
description = server.config.description or ""
# If the server has been manually disabled
if not server.config.active:
description += " (inactive)"
# If server has configuration errors
elif server.config.disabled:
description += " (WARNING: disabled)"
# If server is a passive node
if server.passive_node:
description += " (Passive)"
output.result("list_server", name, description)
output.close_and_exit()
@command(
[
argument(
"--keep-descriptors",
help="Keep the stdout and the stderr streams attached to Barman subprocesses",
action="store_true",
)
]
)
def cron(args):
"""
Run maintenance tasks (global command)
"""
# Skip inactive and temporarily disabled servers
servers = get_server_list(skip_inactive=True, skip_disabled=True)
for name in sorted(servers):
server = servers[name]
# Exception: manage_server_command is not invoked here
# Normally you would call manage_server_command to check if the
# server is None and to report inactive and disabled servers,
# but here we have only active and well configured servers.
try:
server.cron(keep_descriptors=args.keep_descriptors)
except Exception:
# A cron should never raise an exception, so this code
# should never be executed. However, it is here to protect
# unrelated servers in case of unexpected failures.
output.exception(
"Unable to run cron on server '%s', "
"please look in the barman log file for more details.",
name,
)
output.close_and_exit()
# noinspection PyUnusedLocal
def server_completer(prefix, parsed_args, **kwargs):
global_config(parsed_args)
for conf in barman.__config__.servers():
if conf.name.startswith(prefix):
yield conf.name
# noinspection PyUnusedLocal
def server_completer_all(prefix, parsed_args, **kwargs):
global_config(parsed_args)
current_list = getattr(parsed_args, "server_name", None) or ()
for conf in barman.__config__.servers():
if conf.name.startswith(prefix) and conf.name not in current_list:
yield conf.name
if len(current_list) == 0 and "all".startswith(prefix):
yield "all"
# noinspection PyUnusedLocal
def backup_completer(prefix, parsed_args, **kwargs):
global_config(parsed_args)
server = get_server(parsed_args)
backups = server.get_available_backups()
for backup_id in sorted(backups, reverse=True):
if backup_id.startswith(prefix):
yield backup_id
for special_id in ("latest", "last", "oldest", "first", "last-failed"):
if len(backups) > 0 and special_id.startswith(prefix):
yield special_id
@command(
[
argument(
"server_name",
completer=server_completer_all,
nargs="+",
help="specifies the server names for the backup command "
"('all' will show all available servers)",
),
argument(
"--immediate-checkpoint",
help="forces the initial checkpoint to be done as quickly as possible",
dest="immediate_checkpoint",
action="store_true",
default=SUPPRESS,
),
argument(
"--no-immediate-checkpoint",
help="forces the initial checkpoint to be spread",
dest="immediate_checkpoint",
action="store_false",
default=SUPPRESS,
),
argument(
"--reuse-backup",
nargs="?",
choices=barman.config.REUSE_BACKUP_VALUES,
default=None,
const="link",
help="use the previous backup to improve transfer-rate. "
'If no argument is given "link" is assumed',
),
argument(
"--retry-times",
help="Number of retries after an error if base backup copy fails.",
type=check_non_negative,
),
argument(
"--retry-sleep",
help="Wait time after a failed base backup copy, before retrying.",
type=check_non_negative,
),
argument(
"--no-retry",
help="Disable base backup copy retry logic.",
dest="retry_times",
action="store_const",
const=0,
),
argument(
"--jobs",
"-j",
help="Run the copy in parallel using NJOBS processes.",
type=check_positive,
metavar="NJOBS",
),
argument(
"--bwlimit",
help="maximum transfer rate in kilobytes per second. "
"A value of 0 means no limit. Overrides 'bandwidth_limit' "
"configuration option.",
metavar="KBPS",
type=check_non_negative,
default=SUPPRESS,
),
argument(
"--wait",
"-w",
help="wait for all the required WAL files to be archived",
dest="wait",
action="store_true",
default=False,
),
argument(
"--wait-timeout",
help="the time, in seconds, spent waiting for the required "
"WAL files to be archived before timing out",
dest="wait_timeout",
metavar="TIMEOUT",
default=None,
type=check_non_negative,
),
]
)
def backup(args):
"""
Perform a full backup for the given server (supports 'all')
"""
servers = get_server_list(args, skip_inactive=True, skip_passive=True)
for name in sorted(servers):
server = servers[name]
# Skip the server (apply general rule)
if not manage_server_command(server, name):
continue
if args.reuse_backup is not None:
server.config.reuse_backup = args.reuse_backup
if args.retry_sleep is not None:
server.config.basebackup_retry_sleep = args.retry_sleep
if args.retry_times is not None:
server.config.basebackup_retry_times = args.retry_times
if hasattr(args, "immediate_checkpoint"):
server.config.immediate_checkpoint = args.immediate_checkpoint
if args.jobs is not None:
server.config.parallel_jobs = args.jobs
if hasattr(args, "bwlimit"):
server.config.bandwidth_limit = args.bwlimit
with closing(server):
server.backup(wait=args.wait, wait_timeout=args.wait_timeout)
output.close_and_exit()
@command(
[
argument(
"server_name",
completer=server_completer_all,
nargs="+",
help="specifies the server name for the command "
"('all' will show all available servers)",
),
argument("--minimal", help="machine readable output", action="store_true"),
],
cmd_aliases=["list-backup"],
)
def list_backups(args):
"""
List available backups for the given server (supports 'all')
"""
servers = get_server_list(args, skip_inactive=True)
for name in sorted(servers):
server = servers[name]
# Skip the server (apply general rule)
if not manage_server_command(server, name):
continue
output.init("list_backup", name, minimal=args.minimal)
with closing(server):
server.list_backups()
output.close_and_exit()
@command(
[
argument(
"server_name",
completer=server_completer_all,
nargs="+",
help="specifies the server name for the command",
)
]
)
def status(args):
"""
Shows live information and status of the PostgreSQL server
"""
servers = get_server_list(args, skip_inactive=True)
for name in sorted(servers):
server = servers[name]
# Skip the server (apply general rule)
if not manage_server_command(server, name):
continue
output.init("status", name)
with closing(server):
server.status()
output.close_and_exit()
@command(
[
argument(
"server_name",
completer=server_completer_all,
nargs="+",
help="specifies the server name for the command "
"('all' will show all available servers)",
),
argument("--minimal", help="machine readable output", action="store_true"),
argument(
"--target",
choices=("all", "hot-standby", "wal-streamer"),
default="all",
help="""
Possible values are: 'hot-standby' (only hot standby servers),
'wal-streamer' (only WAL streaming clients, such as pg_receivewal),
'all' (any of them). Defaults to %(default)s""",
),
]
)
def replication_status(args):
"""
Shows live information and status of any streaming client
"""
servers = get_server_list(args, skip_inactive=True)
for name in sorted(servers):
server = servers[name]
# Skip the server (apply general rule)
if not manage_server_command(server, name):
continue
with closing(server):
output.init("replication_status", name, minimal=args.minimal)
server.replication_status(args.target)
output.close_and_exit()
@command(
[
argument(
"server_name",
completer=server_completer_all,
nargs="+",
help="specifies the server name for the command ",
)
]
)
def rebuild_xlogdb(args):
"""
Rebuild the WAL file database guessing it from the disk content.
"""
servers = get_server_list(args, skip_inactive=True)
for name in sorted(servers):
server = servers[name]
# Skip the server (apply general rule)
if not manage_server_command(server, name):
continue
with closing(server):
server.rebuild_xlogdb()
output.close_and_exit()
@command(
[
argument(
"server_name",
completer=server_completer,
help="specifies the server name for the command ",
),
argument("--target-tli", help="target timeline", type=check_positive),
argument(
"--target-time",
help="target time. You can use any valid unambiguous representation. "
'e.g: "YYYY-MM-DD HH:MM:SS.mmm"',
),
argument("--target-xid", help="target transaction ID"),
argument("--target-lsn", help="target LSN (Log Sequence Number)"),
argument(
"--target-name",
help="target name created previously with "
"pg_create_restore_point() function call",
),
argument(
"--target-immediate",
help="end recovery as soon as a consistent state is reached",
action="store_true",
default=False,
),
argument(
"--exclusive", help="set target to be non inclusive", action="store_true"
),
argument(
"--tablespace",
help="tablespace relocation rule",
metavar="NAME:LOCATION",
action="append",
),
argument(
"--remote-ssh-command",
metavar="SSH_COMMAND",
help="This options activates remote recovery, by specifying the secure "
"shell command to be launched on a remote host. It is "
'the equivalent of the "ssh_command" server option in '
"the configuration file for remote recovery. "
'Example: "ssh postgres@db2"',
),
argument(
"backup_id",
completer=backup_completer,
help="specifies the backup ID to recover",
),
argument(
"destination_directory",
help="the directory where the new server is created",
),
argument(
"--bwlimit",
help="maximum transfer rate in kilobytes per second. "
"A value of 0 means no limit. Overrides 'bandwidth_limit' "
"configuration option.",
metavar="KBPS",
type=check_non_negative,
default=SUPPRESS,
),
argument(
"--retry-times",
help="Number of retries after an error if base backup copy fails.",
type=check_non_negative,
),
argument(
"--retry-sleep",
help="Wait time after a failed base backup copy, before retrying.",
type=check_non_negative,
),
argument(
"--no-retry",
help="Disable base backup copy retry logic.",
dest="retry_times",
action="store_const",
const=0,
),
argument(
"--jobs",
"-j",
help="Run the copy in parallel using NJOBS processes.",
type=check_positive,
metavar="NJOBS",
),
argument(
"--get-wal",
help="Enable the get-wal option during the recovery.",
dest="get_wal",
action="store_true",
default=SUPPRESS,
),
argument(
"--no-get-wal",
help="Disable the get-wal option during recovery.",
dest="get_wal",
action="store_false",
default=SUPPRESS,
),
argument(
"--network-compression",
help="Enable network compression during remote recovery.",
dest="network_compression",
action="store_true",
default=SUPPRESS,
),
argument(
"--no-network-compression",
help="Disable network compression during remote recovery.",
dest="network_compression",
action="store_false",
default=SUPPRESS,
),
argument(
"--target-action",
help="Specifies what action the server should take once the "
"recovery target is reached. This option is not allowed for "
"PostgreSQL < 9.1. If PostgreSQL is between 9.1 and 9.4 included "
'the only allowed value is "pause". If PostgreSQL is 9.5 or newer '
'the possible values are "shutdown", "pause", "promote".',
dest="target_action",
type=check_target_action,
default=SUPPRESS,
),
argument(
"--standby-mode",
dest="standby_mode",
action="store_true",
default=SUPPRESS,
help="Enable standby mode when starting the recovered PostgreSQL instance",
),
]
)
def recover(args):
"""
Recover a server at a given time, name, LSN or xid
"""
server = get_server(args)
# Retrieves the backup
backup_id = parse_backup_id(server, args)
if backup_id.status not in BackupInfo.STATUS_COPY_DONE:
output.error(
"Cannot recover from backup '%s' of server '%s': "
"backup status is not DONE",
args.backup_id,
server.config.name,
)
output.close_and_exit()
# decode the tablespace relocation rules
tablespaces = {}
if args.tablespace:
for rule in args.tablespace:
try:
tablespaces.update([rule.split(":", 1)])
except ValueError:
output.error(
"Invalid tablespace relocation rule '%s'\n"
"HINT: The valid syntax for a relocation rule is "
"NAME:LOCATION",
rule,
)
output.close_and_exit()
# validate the rules against the tablespace list
valid_tablespaces = []
if backup_id.tablespaces:
valid_tablespaces = [
tablespace_data.name for tablespace_data in backup_id.tablespaces
]
for item in tablespaces:
if item not in valid_tablespaces:
output.error(
"Invalid tablespace name '%s'\n"
"HINT: Please use any of the following "
"tablespaces: %s",
item,
", ".join(valid_tablespaces),
)
output.close_and_exit()
# explicitly disallow the rsync remote syntax (common mistake)
if ":" in args.destination_directory:
output.error(
"The destination directory parameter "
"cannot contain the ':' character\n"
"HINT: If you want to do a remote recovery you have to use "
"the --remote-ssh-command option"
)
output.close_and_exit()
if args.retry_sleep is not None:
server.config.basebackup_retry_sleep = args.retry_sleep
if args.retry_times is not None:
server.config.basebackup_retry_times = args.retry_times
if hasattr(args, "get_wal"):
if args.get_wal:
server.config.recovery_options.add(RecoveryOptions.GET_WAL)
else:
server.config.recovery_options.remove(RecoveryOptions.GET_WAL)
if args.jobs is not None:
server.config.parallel_jobs = args.jobs
if hasattr(args, "bwlimit"):
server.config.bandwidth_limit = args.bwlimit
# PostgreSQL supports multiple parameters to specify when the recovery
# process will end, and in that case the last entry in recovery
# configuration files will be used. See [1]
#
# Since the meaning of the target options is not dependent on the order
# of parameters, we decided to make the target options mutually exclusive.
#
# [1]: https://www.postgresql.org/docs/current/static/
# recovery-target-settings.html
target_options = [
"target_time",
"target_xid",
"target_lsn",
"target_name",
"target_immediate",
]
specified_target_options = len(
[option for option in target_options if getattr(args, option)]
)
if specified_target_options > 1:
output.error("You cannot specify multiple targets for the recovery operation")
output.close_and_exit()
if hasattr(args, "network_compression"):
if args.network_compression and args.remote_ssh_command is None:
output.error(
"Network compression can only be used with "
"remote recovery.\n"
"HINT: If you want to do a remote recovery "
"you have to use the --remote-ssh-command option"
)
output.close_and_exit()
server.config.network_compression = args.network_compression
with closing(server):
try:
server.recover(
backup_id,
args.destination_directory,
tablespaces=tablespaces,
target_tli=args.target_tli,
target_time=args.target_time,
target_xid=args.target_xid,
target_lsn=args.target_lsn,
target_name=args.target_name,
target_immediate=args.target_immediate,
exclusive=args.exclusive,
remote_command=args.remote_ssh_command,
target_action=getattr(args, "target_action", None),
standby_mode=getattr(args, "standby_mode", None),
)
except RecoveryException as exc:
output.error(force_str(exc))
output.close_and_exit()
@command(
[
argument(
"server_name",
completer=server_completer_all,
nargs="+",
help="specifies the server names to show "
"('all' will show all available servers)",
)
],
cmd_aliases=["show-server"],
)
def show_servers(args):
"""
Show all configuration parameters for the specified servers
"""
servers = get_server_list(args)
for name in sorted(servers):
server = servers[name]
# Skip the server (apply general rule)
if not manage_server_command(
server,
name,
skip_inactive=False,
skip_disabled=False,
disabled_is_error=False,
):
continue
# If the server has been manually disabled
if not server.config.active:
name += " (inactive)"
# If server has configuration errors
elif server.config.disabled:
name += " (WARNING: disabled)"
output.init("show_server", name)
with closing(server):
server.show()
output.close_and_exit()
@command(
[
argument(
"server_name",
completer=server_completer_all,
nargs="+",
help="specifies the server name target of the switch-wal command",
),
argument(
"--force",
help="forces the switch of a WAL by executing a checkpoint before",
dest="force",
action="store_true",
default=False,
),
argument(
"--archive",
help="wait for one WAL file to be archived",
dest="archive",
action="store_true",
default=False,
),
argument(
"--archive-timeout",
help="the time, in seconds, the archiver will wait for a new WAL file "
"to be archived before timing out",
metavar="TIMEOUT",
default="30",
type=check_non_negative,
),
],
cmd_aliases=["switch-xlog"],
)
def switch_wal(args):
"""
Execute the switch-wal command on the target server
"""
servers = get_server_list(args, skip_inactive=True)
for name in sorted(servers):
server = servers[name]
# Skip the server (apply general rule)
if not manage_server_command(server, name):
continue
with closing(server):
server.switch_wal(args.force, args.archive, args.archive_timeout)
output.close_and_exit()
@command(
[
argument(
"server_name",
completer=server_completer_all,
nargs="+",
help="specifies the server names to check "
"('all' will check all available servers)",
),
argument(
"--nagios", help="Nagios plugin compatible output", action="store_true"
),
]
)
def check(args):
"""
Check if the server configuration is working.
This command returns success if every checks pass,
or failure if any of these fails
"""
if args.nagios:
output.set_output_writer(output.NagiosOutputWriter())
servers = get_server_list(args)
for name in sorted(servers):
server = servers[name]
# Validate the returned server
if not manage_server_command(
server,
name,
skip_inactive=False,
skip_disabled=False,
disabled_is_error=False,
):
continue
output.init("check", name, server.config.active, server.config.disabled)
with closing(server):
server.check()
output.close_and_exit()
@command()
def diagnose(args=None):
"""
Diagnostic command (for support and problems detection purpose)
"""
# Get every server (both inactive and temporarily disabled)
servers = get_server_list(on_error_stop=False, suppress_error=True)
# errors list with duplicate paths between servers
errors_list = barman.__config__.servers_msg_list
barman.diagnose.exec_diagnose(servers, errors_list)
output.close_and_exit()
@command(
[
argument(
"--primary",
help="execute the sync-info on the primary node (if set)",
action="store_true",
default=SUPPRESS,
),
argument(
"server_name",
completer=server_completer,
help="specifies the server name for the command",
),
argument(
"last_wal", help="specifies the name of the latest WAL read", nargs="?"
),
argument(
"last_position",
nargs="?",
type=check_positive,
help="the last position read from xlog database (in bytes)",
),
]
)
def sync_info(args):
"""
Output the internal synchronisation status.
Used to sync_backup with a passive node
"""
server = get_server(args)
try:
# if called with --primary option
if getattr(args, "primary", False):
primary_info = server.primary_node_info(args.last_wal, args.last_position)
output.info(
json.dumps(primary_info, cls=BarmanEncoder, indent=4), log=False
)
else:
server.sync_status(args.last_wal, args.last_position)
except SyncError as e:
# Catch SyncError exceptions and output only the error message,
# preventing from logging the stack trace
output.error(e)
output.close_and_exit()
@command(
[
argument(
"server_name",
completer=server_completer,
help="specifies the server name for the command",
),
argument(
"backup_id", help="specifies the backup ID to be copied on the passive node"
),
]
)
def sync_backup(args):
"""
Command that synchronises a backup from a master to a passive node
"""
server = get_server(args)
try:
server.sync_backup(args.backup_id)
except SyncError as e:
# Catch SyncError exceptions and output only the error message,
# preventing from logging the stack trace
output.error(e)
output.close_and_exit()
@command(
[
argument(
"server_name",
completer=server_completer,
help="specifies the server name for the command",
)
]
)
def sync_wals(args):
"""
Command that synchronises WAL files from a master to a passive node
"""
server = get_server(args)
try:
server.sync_wals()
except SyncError as e:
# Catch SyncError exceptions and output only the error message,
# preventing from logging the stack trace
output.error(e)
output.close_and_exit()
@command(
[
argument(
"server_name",
completer=server_completer,
help="specifies the server name for the command",
),
argument(
"backup_id", completer=backup_completer, help="specifies the backup ID"
),
],
cmd_aliases=["show-backups"],
)
def show_backup(args):
"""
This method shows a single backup information
"""
server = get_server(args)
# Retrieves the backup
backup_info = parse_backup_id(server, args)
with closing(server):
server.show_backup(backup_info)
output.close_and_exit()
@command(
[
argument(
"server_name",
completer=server_completer,
help="specifies the server name for the command",
),
argument(
"backup_id", completer=backup_completer, help="specifies the backup ID"
),
argument(
"--target",
choices=("standalone", "data", "wal", "full"),
default="standalone",
help="""
Possible values are: data (just the data files), standalone
(base backup files, including required WAL files),
wal (just WAL files between the beginning of base
backup and the following one (if any) or the end of the log) and
full (same as data + wal). Defaults to %(default)s""",
),
]
)
def list_files(args):
"""
List all the files for a single backup
"""
server = get_server(args)
# Retrieves the backup
backup_info = parse_backup_id(server, args)
try:
for line in backup_info.get_list_of_files(args.target):
output.info(line, log=False)
except BadXlogSegmentName as e:
output.error(
"invalid xlog segment name %r\n"
'HINT: Please run "barman rebuild-xlogdb %s" '
"to solve this issue",
force_str(e),
server.config.name,
)
output.close_and_exit()
@command(
[
argument(
"server_name",
completer=server_completer,
help="specifies the server name for the command",
),
argument(
"backup_id", completer=backup_completer, help="specifies the backup ID"
),
]
)
def delete(args):
"""
Delete a backup
"""
server = get_server(args)
# Retrieves the backup
backup_id = parse_backup_id(server, args)
with closing(server):
if not server.delete_backup(backup_id):
output.error(
"Cannot delete backup (%s %s)" % (server.config.name, backup_id)
)
output.close_and_exit()
@command(
[
argument(
"server_name",
completer=server_completer,
help="specifies the server name for the command",
),
argument("wal_name", help="the WAL file to get"),
argument(
"--output-directory",
"-o",
help="put the retrieved WAL file in this directory with the original name",
default=SUPPRESS,
),
argument(
"--partial",
"-P",
help="retrieve also partial WAL files (.partial)",
action="store_true",
dest="partial",
default=False,
),
argument(
"--gzip",
"-z",
"-x",
help="compress the output with gzip",
action="store_const",
const="gzip",
dest="compression",
default=SUPPRESS,
),
argument(
"--bzip2",
"-j",
help="compress the output with bzip2",
action="store_const",
const="bzip2",
dest="compression",
default=SUPPRESS,
),
argument(
"--peek",
"-p",
help="peek from the WAL archive up to 'SIZE' WAL files, starting "
"from the requested one. 'SIZE' must be an integer >= 1. "
"When invoked with this option, get-wal returns a list of "
"zero to 'SIZE' WAL segment names, one per row.",
metavar="SIZE",
type=check_positive,
default=SUPPRESS,
),
argument(
"--test",
"-t",
help="test both the connection and the configuration of the requested "
"PostgreSQL server in Barman for WAL retrieval. With this option, "
"the 'wal_name' mandatory argument is ignored.",
action="store_true",
default=SUPPRESS,
),
]
)
def get_wal(args):
"""
Retrieve WAL_NAME file from SERVER_NAME archive.
The content will be streamed on standard output unless
the --output-directory option is specified.
"""
server = get_server(args, inactive_is_error=True)
if getattr(args, "test", None):
output.info(
"Ready to retrieve WAL files from the server %s", server.config.name
)
return
# Retrieve optional arguments. If an argument is not specified,
# the namespace doesn't contain it due to SUPPRESS default.
# In that case we pick 'None' using getattr third argument.
compression = getattr(args, "compression", None)
output_directory = getattr(args, "output_directory", None)
peek = getattr(args, "peek", None)
with closing(server):
server.get_wal(
args.wal_name,
compression=compression,
output_directory=output_directory,
peek=peek,
partial=args.partial,
)
output.close_and_exit()
@command(
[
argument(
"server_name",
completer=server_completer,
help="specifies the server name for the command",
),
argument(
"--test",
"-t",
help="test both the connection and the configuration of the requested "
"PostgreSQL server in Barman to make sure it is ready to receive "
"WAL files.",
action="store_true",
default=SUPPRESS,
),
]
)
def put_wal(args):
"""
Receive a WAL file from SERVER_NAME and securely store it in the incoming
directory. The file will be read from standard input in tar format.
"""
server = get_server(args, inactive_is_error=True)
if getattr(args, "test", None):
output.info("Ready to accept WAL files for the server %s", server.config.name)
return
try:
# Python 3.x
stream = sys.stdin.buffer
except AttributeError:
# Python 2.x
stream = sys.stdin
with closing(server):
server.put_wal(stream)
output.close_and_exit()
@command(
[
argument(
"server_name",
completer=server_completer,
help="specifies the server name for the command",
)
]
)
def archive_wal(args):
"""
Execute maintenance operations on WAL files for a given server.
This command processes any incoming WAL files for the server
and archives them along the catalogue.
"""
server = get_server(args)
with closing(server):
server.archive_wal()
output.close_and_exit()
@command(
[
argument(
"--stop",
help="stop the receive-wal subprocess for the server",
action="store_true",
),
argument(
"--reset",
help="reset the status of receive-wal removing any status files",
action="store_true",
),
argument(
"--create-slot",
help="create the replication slot, if it does not exist",
action="store_true",
),
argument(
"--drop-slot",
help="drop the replication slot, if it exists",
action="store_true",
),
argument(
"server_name",
completer=server_completer,
help="specifies the server name for the command",
),
]
)
def receive_wal(args):
"""
Start a receive-wal process.
The process uses the streaming protocol to receive WAL files
from the PostgreSQL server.
"""
server = get_server(args)
if args.stop and args.reset:
output.error("--stop and --reset options are not compatible")
# If the caller requested to shutdown the receive-wal process deliver the
# termination signal, otherwise attempt to start it
elif args.stop:
server.kill("receive-wal")
elif args.create_slot:
with closing(server):
server.create_physical_repslot()
elif args.drop_slot:
with closing(server):
server.drop_repslot()
else:
with closing(server):
server.receive_wal(reset=args.reset)
output.close_and_exit()
@command(
[
argument(
"server_name",
completer=server_completer,
help="specifies the server name for the command",
),
argument(
"backup_id", completer=backup_completer, help="specifies the backup ID"
),
]
)
def check_backup(args):
"""
Make sure that all the required WAL files to check
the consistency of a physical backup (that is, from the
beginning to the end of the full backup) are correctly
archived. This command is automatically invoked by the
cron command and at the end of every backup operation.
"""
server = get_server(args)
# Retrieves the backup
backup_info = parse_backup_id(server, args)
with closing(server):
server.check_backup(backup_info)
output.close_and_exit()
@command(
[
argument(
"server_name",
completer=server_completer,
help="specifies the server name for the command ",
),
argument(
"backup_id", completer=backup_completer, help="specifies the backup ID"
),
],
cmd_aliases=["verify"],
)
def verify_backup(args):
"""
verify a backup for the given server and backup id
"""
# get barman.server.Server
server = get_server(args)
# Raises an error if wrong backup
backup_info = parse_backup_id(server, args)
# get backup path
output.info("Verifying backup %s on server %s" % (args.backup_id, args.server_name))
server.backup_manager.verify_backup(backup_info)
output.close_and_exit()
@command(
[
argument(
"server_name",
completer=server_completer,
help="specifies the server name for the command ",
),
argument(
"backup_id", completer=backup_completer, help="specifies the backup ID"
),
],
)
def generate_manifest(args):
"""
Generate a manifest-backup for the given server and backup id
"""
server = get_server(args)
# Raises an error if wrong backup
backup_info = parse_backup_id(server, args)
# know context (remote backup? local?)
local_file_manager = LocalFileManager()
backup_manifest = BackupManifest(
backup_info.get_data_directory(), local_file_manager, SHA256()
)
backup_manifest.create_backup_manifest()
output.info("Backup %s is valid on server %s" % (args.backup_id, args.server_name))
output.close_and_exit()
@command(
[
argument(
"server_name",
completer=server_completer,
help="specifies the server name for the command",
),
argument(
"backup_id", completer=backup_completer, help="specifies the backup ID"
),
argument("--release", help="remove the keep annotation", action="store_true"),
argument(
"--status", help="return the keep status of the backup", action="store_true"
),
argument(
"--target",
help="keep this backup with the specified recovery target",
choices=[KeepManager.TARGET_FULL, KeepManager.TARGET_STANDALONE],
),
]
)
def keep(args):
"""
Tag the specified backup so that it will never be deleted
"""
if not any((args.release, args.status, args.target)):
output.error(
"one of the arguments -r/--release -s/--status --target is required"
)
output.close_and_exit()
server = get_server(args)
backup_info = parse_backup_id(server, args)
backup_manager = server.backup_manager
if args.status:
output.init("status", server.config.name)
target = backup_manager.get_keep_target(backup_info.backup_id)
if target:
output.result("status", server.config.name, "keep_status", "Keep", target)
else:
output.result("status", server.config.name, "keep_status", "Keep", "nokeep")
elif args.release:
backup_manager.release_keep(backup_info.backup_id)
else:
if backup_info.status != BackupInfo.DONE:
msg = (
"Cannot add keep to backup %s because it has status %s. "
"Only backups with status DONE can be kept."
) % (backup_info.backup_id, backup_info.status)
output.error(msg)
output.close_and_exit()
backup_manager.keep_backup(backup_info.backup_id, args.target)
@command(
[
argument(
"server_name",
completer=server_completer,
help="specifies the server name for the command",
),
argument(
"--timeline",
help="the earliest timeline whose WALs should cause the check to fail",
type=check_positive,
),
]
)
def check_wal_archive(args):
"""
Check the WAL archive can be safely used for a new server.
This will fail if there are any existing WALs in the archive.
If the --timeline option is used then any WALs on earlier timelines
than that specified will not cause the check to fail.
"""
server = get_server(args)
output.init("check_wal_archive", server.config.name)
with server.xlogdb() as fxlogdb:
wals = [WalFileInfo.from_xlogdb_line(w).name for w in fxlogdb]
try:
check_archive_usable(
wals,
timeline=args.timeline,
)
output.result("check_wal_archive", server.config.name)
except WalArchiveContentError as err:
msg = "WAL archive check failed for server %s: %s" % (
server.config.name,
force_str(err),
)
logging.error(msg)
output.error(msg)
output.close_and_exit()
def pretty_args(args):
"""
Prettify the given argparse namespace to be human readable
:type args: argparse.Namespace
:return: the human readable content of the namespace
"""
values = dict(vars(args))
# Retrieve the command name with recent argh versions
if "_functions_stack" in values:
values["command"] = values["_functions_stack"][0].__name__
del values["_functions_stack"]
# Older argh versions only have the matching function in the namespace
elif "function" in values:
values["command"] = values["function"].__name__
del values["function"]
return "%r" % values
def global_config(args):
"""
Set the configuration file
"""
if hasattr(args, "config"):
filename = args.config
else:
try:
filename = os.environ["BARMAN_CONFIG_FILE"]
except KeyError:
filename = None
config = barman.config.Config(filename)
barman.__config__ = config
# change user if needed
try:
drop_privileges(config.user)
except OSError:
msg = "ERROR: please run barman as %r user" % config.user
raise SystemExit(msg)
except KeyError:
msg = "ERROR: the configured user %r does not exists" % config.user
raise SystemExit(msg)
# configure logging
if hasattr(args, "log_level"):
config.log_level = args.log_level
log_level = parse_log_level(config.log_level)
configure_logging(
config.log_file, log_level or barman.config.DEFAULT_LOG_LEVEL, config.log_format
)
if log_level is None:
_logger.warning("unknown log_level in config file: %s", config.log_level)
# Configure output
if args.format != output.DEFAULT_WRITER or args.quiet or args.debug:
output.set_output_writer(args.format, quiet=args.quiet, debug=args.debug)
# Configure color output
if args.color == "auto":
# Enable colored output if both stdout and stderr are TTYs
output.ansi_colors_enabled = sys.stdout.isatty() and sys.stderr.isatty()
else:
output.ansi_colors_enabled = args.color == "always"
# Load additional configuration files
config.load_configuration_files_directory()
# We must validate the configuration here in order to have
# both output and logging configured
config.validate_global_config()
_logger.debug(
"Initialised Barman version %s (config: %s, args: %s)",
barman.__version__,
config.config_file,
pretty_args(args),
)
def get_server(
args,
skip_inactive=True,
skip_disabled=False,
skip_passive=False,
inactive_is_error=False,
on_error_stop=True,
suppress_error=False,
):
"""
Get a single server retrieving its configuration (wraps get_server_list())
Returns a Server object or None if the required server is unknown and
on_error_stop is False.
WARNING: this function modifies the 'args' parameter
:param args: an argparse namespace containing a single
server_name parameter
WARNING: the function modifies the content of this parameter
:param bool skip_inactive: do nothing if the server is inactive
:param bool skip_disabled: do nothing if the server is disabled
:param bool skip_passive: do nothing if the server is passive
:param bool inactive_is_error: treat inactive server as error
:param bool on_error_stop: stop if an error is found
:param bool suppress_error: suppress display of errors (e.g. diagnose)
:rtype: Server|None
"""
# This function must to be called with in a single-server context
name = args.server_name
assert isinstance(name, str)
# The 'all' special name is forbidden in this context
if name == "all":
output.error("You cannot use 'all' in a single server context")
output.close_and_exit()
# The following return statement will never be reached
# but it is here for clarity
return None
# Builds a list from a single given name
args.server_name = [name]
# Skip_inactive is reset if inactive_is_error is set, because
# it needs to retrieve the inactive server to emit the error.
skip_inactive &= not inactive_is_error
# Retrieve the requested server
servers = get_server_list(
args, skip_inactive, skip_disabled, skip_passive, on_error_stop, suppress_error
)
# The requested server has been excluded from get_server_list result
if len(servers) == 0:
output.close_and_exit()
# The following return statement will never be reached
# but it is here for clarity
return None
# retrieve the server object
server = servers[name]
# Apply standard validation control and skips
# the server if inactive or disabled, displaying standard
# error messages. If on_error_stop (default) exits
if not manage_server_command(server, name, inactive_is_error) and on_error_stop:
output.close_and_exit()
# The following return statement will never be reached
# but it is here for clarity
return None
# Returns the filtered server
return server
def get_server_list(
args=None,
skip_inactive=False,
skip_disabled=False,
skip_passive=False,
on_error_stop=True,
suppress_error=False,
):
"""
Get the server list from the configuration
If args the parameter is None or arg.server_name is ['all']
returns all defined servers
:param args: an argparse namespace containing a list server_name parameter
:param bool skip_inactive: skip inactive servers when 'all' is required
:param bool skip_disabled: skip disabled servers when 'all' is required
:param bool skip_passive: skip passive servers when 'all' is required
:param bool on_error_stop: stop if an error is found
:param bool suppress_error: suppress display of errors (e.g. diagnose)
:rtype: dict[str,Server]
"""
server_dict = {}
# This function must to be called with in a multiple-server context
assert not args or isinstance(args.server_name, list)
# Generate the list of servers (required for global errors)
available_servers = barman.__config__.server_names()
# Get a list of configuration errors from all the servers
global_error_list = barman.__config__.servers_msg_list
# Global errors have higher priority
if global_error_list:
# Output the list of global errors
if not suppress_error:
for error in global_error_list:
output.error(error)
# If requested, exit on first error
if on_error_stop:
output.close_and_exit()
# The following return statement will never be reached
# but it is here for clarity
return {}
# Handle special 'all' server cases
# - args is None
# - 'all' special name
if not args or "all" in args.server_name:
# When 'all' is used, it must be the only specified argument
if args and len(args.server_name) != 1:
output.error("You cannot use 'all' with other server names")
servers = available_servers
else:
# Put servers in a set, so multiple occurrences are counted only once
servers = set(args.server_name)
# Loop through all the requested servers
for server in servers:
conf = barman.__config__.get_server(server)
if conf is None:
# Unknown server
server_dict[server] = None
else:
server_object = Server(conf)
# Skip inactive servers, if requested
if skip_inactive and not server_object.config.active:
output.info("Skipping inactive server '%s'" % conf.name)
continue
# Skip disabled servers, if requested
if skip_disabled and server_object.config.disabled:
output.info("Skipping temporarily disabled server '%s'" % conf.name)
continue
# Skip passive nodes, if requested
if skip_passive and server_object.passive_node:
output.info("Skipping passive server '%s'", conf.name)
continue
server_dict[server] = server_object
return server_dict
def manage_server_command(
server,
name=None,
inactive_is_error=False,
disabled_is_error=True,
skip_inactive=True,
skip_disabled=True,
):
"""
Standard and consistent method for managing server errors within
a server command execution. By default, suggests to skip any inactive
and disabled server; it also emits errors for disabled servers by
default.
Returns True if the command has to be executed for this server.
:param barman.server.Server server: server to be checked for errors
:param str name: name of the server, in a multi-server command
:param bool inactive_is_error: treat inactive server as error
:param bool disabled_is_error: treat disabled server as error
:param bool skip_inactive: skip if inactive
:param bool skip_disabled: skip if disabled
:return: True if the command has to be executed on this server
:rtype: boolean
"""
# Unknown server (skip it)
if not server:
output.error("Unknown server '%s'" % name)
return False
if not server.config.active:
# Report inactive server as error
if inactive_is_error:
output.error("Inactive server: %s" % server.config.name)
if skip_inactive:
return False
# Report disabled server as error
if server.config.disabled:
# Output all the messages as errors, and exit terminating the run.
if disabled_is_error:
for message in server.config.msg_list:
output.error(message)
if skip_disabled:
return False
# All ok, execute the command
return True
def parse_backup_id(server, args):
"""
Parses backup IDs including special words such as latest, oldest, etc.
Exit with error if the backup id doesn't exist.
:param Server server: server object to search for the required backup
:param args: command line arguments namespace
:rtype: barman.infofile.LocalBackupInfo
"""
if args.backup_id in ("latest", "last"):
backup_id = server.get_last_backup_id()
elif args.backup_id in ("oldest", "first"):
backup_id = server.get_first_backup_id()
elif args.backup_id in ("last-failed"):
backup_id = server.get_last_backup_id([BackupInfo.FAILED])
else:
backup_id = args.backup_id
backup_info = server.get_backup(backup_id)
if backup_info is None:
output.error(
"Unknown backup '%s' for server '%s'", args.backup_id, server.config.name
)
output.close_and_exit()
return backup_info
def main():
"""
The main method of Barman
"""
# noinspection PyBroadException
try:
argcomplete.autocomplete(p)
args = p.parse_args()
global_config(args)
if args.command is None:
p.print_help()
else:
args.func(args)
except KeyboardInterrupt:
msg = "Process interrupted by user (KeyboardInterrupt)"
output.error(msg)
except Exception as e:
msg = "%s\nSee log file for more details." % e
output.exception(msg)
# cleanup output API and exit honoring output.error_occurred and
# output.error_exit_code
output.close_and_exit()
if __name__ == "__main__":
# This code requires the mock module and allow us to test
# bash completion inside the IDE debugger
try:
# noinspection PyUnresolvedReferences
import mock
sys.stdout = mock.Mock(wraps=sys.stdout)
sys.stdout.isatty.return_value = True
os.dup2(2, 8)
except ImportError:
pass
main()
barman-2.18/barman/recovery_executor.py 0000644 0006212 0006212 00000153107 14172556763 016475 0 ustar 0000000 0000000 # -*- coding: utf-8 -*-
# © Copyright EnterpriseDB UK Limited 2011-2022
#
# This file is part of Barman.
#
# Barman is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Barman is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Barman. If not, see .
"""
This module contains the methods necessary to perform a recovery
"""
from __future__ import print_function
import collections
import datetime
import logging
import os
import re
import shutil
import socket
import tempfile
import time
from io import BytesIO
import dateutil.parser
import dateutil.tz
from barman import output, xlog
from barman.command_wrappers import RsyncPgData
from barman.config import RecoveryOptions
from barman.copy_controller import RsyncCopyController
from barman.exceptions import (
BadXlogSegmentName,
CommandFailedException,
DataTransferFailure,
FsOperationFailed,
RecoveryInvalidTargetException,
RecoveryStandbyModeException,
RecoveryTargetActionException,
)
from barman.fs import UnixLocalCommand, UnixRemoteCommand
from barman.infofile import BackupInfo, LocalBackupInfo
from barman.utils import force_str, mkpath
# generic logger for this module
_logger = logging.getLogger(__name__)
# regexp matching a single value in Postgres configuration file
PG_CONF_SETTING_RE = re.compile(r"^\s*([^\s=]+)\s*=?\s*(.*)$")
# create a namedtuple object called Assertion
# with 'filename', 'line', 'key' and 'value' as properties
Assertion = collections.namedtuple("Assertion", "filename line key value")
# noinspection PyMethodMayBeStatic
class RecoveryExecutor(object):
"""
Class responsible of recovery operations
"""
# Potentially dangerous options list, which need to be revised by the user
# after a recovery
DANGEROUS_OPTIONS = [
"data_directory",
"config_file",
"hba_file",
"ident_file",
"external_pid_file",
"ssl_cert_file",
"ssl_key_file",
"ssl_ca_file",
"ssl_crl_file",
"unix_socket_directory",
"unix_socket_directories",
"include",
"include_dir",
"include_if_exists",
]
# List of options that, if present, need to be forced to a specific value
# during recovery, to avoid data losses
MANGLE_OPTIONS = {
# Dangerous options
"archive_command": "false",
# Recovery options that may interfere with recovery targets
"recovery_target": None,
"recovery_target_name": None,
"recovery_target_time": None,
"recovery_target_xid": None,
"recovery_target_lsn": None,
"recovery_target_inclusive": None,
"recovery_target_timeline": None,
"recovery_target_action": None,
}
def __init__(self, backup_manager):
"""
Constructor
:param barman.backup.BackupManager backup_manager: the BackupManager
owner of the executor
"""
self.backup_manager = backup_manager
self.server = backup_manager.server
self.config = backup_manager.config
self.temp_dirs = []
def recover(
self,
backup_info,
dest,
tablespaces=None,
remote_command=None,
target_tli=None,
target_time=None,
target_xid=None,
target_lsn=None,
target_name=None,
target_immediate=False,
exclusive=False,
target_action=None,
standby_mode=None,
):
"""
Performs a recovery of a backup
This method should be called in a closing context
:param barman.infofile.BackupInfo backup_info: the backup to recover
:param str dest: the destination directory
:param dict[str,str]|None tablespaces: a tablespace
name -> location map (for relocation)
:param str|None remote_command: The remote command to recover
the base backup, in case of remote backup.
:param str|None target_tli: the target timeline
:param str|None target_time: the target time
:param str|None target_xid: the target xid
:param str|None target_lsn: the target LSN
:param str|None target_name: the target name created previously with
pg_create_restore_point() function call
:param str|None target_immediate: end recovery as soon as consistency
is reached
:param bool exclusive: whether the recovery is exclusive or not
:param str|None target_action: The recovery target action
:param bool|None standby_mode: standby mode
"""
# Run the cron to be sure the wal catalog is up to date
# Prepare a map that contains all the objects required for a recovery
recovery_info = self._setup(backup_info, remote_command, dest)
output.info(
"Starting %s restore for server %s using backup %s",
recovery_info["recovery_dest"],
self.server.config.name,
backup_info.backup_id,
)
output.info("Destination directory: %s", dest)
if remote_command:
output.info("Remote command: %s", remote_command)
# If the backup we are recovering is still not validated and we
# haven't requested the get-wal feature, display a warning message
if not recovery_info["get_wal"]:
if backup_info.status == BackupInfo.WAITING_FOR_WALS:
output.warning(
"IMPORTANT: You have requested a recovery operation for "
"a backup that does not have yet all the WAL files that "
"are required for consistency."
)
# Set targets for PITR
self._set_pitr_targets(
recovery_info,
backup_info,
dest,
target_name,
target_time,
target_tli,
target_xid,
target_lsn,
target_immediate,
target_action,
)
# Retrieve the safe_horizon for smart copy
self._retrieve_safe_horizon(recovery_info, backup_info, dest)
# check destination directory. If doesn't exist create it
try:
recovery_info["cmd"].create_dir_if_not_exists(dest)
except FsOperationFailed as e:
output.error("unable to initialise destination directory '%s': %s", dest, e)
output.close_and_exit()
# Initialize tablespace directories
if backup_info.tablespaces:
self._prepare_tablespaces(
backup_info, recovery_info["cmd"], dest, tablespaces
)
# Copy the base backup
output.info("Copying the base backup.")
try:
self._backup_copy(
backup_info,
dest,
tablespaces,
remote_command,
recovery_info["safe_horizon"],
)
except DataTransferFailure as e:
output.error("Failure copying base backup: %s", e)
output.close_and_exit()
# Copy the backup.info file in the destination as
# ".barman-recover.info"
if remote_command:
try:
recovery_info["rsync"](
backup_info.filename, ":%s/.barman-recover.info" % dest
)
except CommandFailedException as e:
output.error("copy of recovery metadata file failed: %s", e)
output.close_and_exit()
else:
backup_info.save(os.path.join(dest, ".barman-recover.info"))
# Standby mode is not available for PostgreSQL older than 9.0
if backup_info.version < 90000 and standby_mode:
raise RecoveryStandbyModeException(
"standby_mode is available only from PostgreSQL 9.0"
)
# Restore the WAL segments. If GET_WAL option is set, skip this phase
# as they will be retrieved using the wal-get command.
if not recovery_info["get_wal"]:
# If the backup we restored is still waiting for WALS, read the
# backup info again and check whether it has been validated.
# Notify the user if it is still not DONE.
if backup_info.status == BackupInfo.WAITING_FOR_WALS:
data = LocalBackupInfo(self.server, backup_info.filename)
if data.status == BackupInfo.WAITING_FOR_WALS:
output.warning(
"IMPORTANT: The backup we have recovered IS NOT "
"VALID. Required WAL files for consistency are "
"missing. Please verify that WAL archiving is "
"working correctly or evaluate using the 'get-wal' "
"option for recovery"
)
output.info("Copying required WAL segments.")
required_xlog_files = () # Makes static analysers happy
try:
# TODO: Stop early if taget-immediate
# Retrieve a list of required log files
required_xlog_files = tuple(
self.server.get_required_xlog_files(
backup_info, target_tli, recovery_info["target_epoch"]
)
)
# Restore WAL segments into the wal_dest directory
self._xlog_copy(
required_xlog_files, recovery_info["wal_dest"], remote_command
)
except DataTransferFailure as e:
output.error("Failure copying WAL files: %s", e)
output.close_and_exit()
except BadXlogSegmentName as e:
output.error(
"invalid xlog segment name %r\n"
'HINT: Please run "barman rebuild-xlogdb %s" '
"to solve this issue",
force_str(e),
self.config.name,
)
output.close_and_exit()
# If WAL files are put directly in the pg_xlog directory,
# avoid shipping of just recovered files
# by creating the corresponding archive status file
if not recovery_info["is_pitr"]:
output.info("Generating archive status files")
self._generate_archive_status(
recovery_info, remote_command, required_xlog_files
)
# Generate recovery.conf file (only if needed by PITR or get_wal)
is_pitr = recovery_info["is_pitr"]
get_wal = recovery_info["get_wal"]
if is_pitr or get_wal or standby_mode:
output.info("Generating recovery configuration")
self._generate_recovery_conf(
recovery_info,
backup_info,
dest,
target_immediate,
exclusive,
remote_command,
target_name,
target_time,
target_tli,
target_xid,
target_lsn,
standby_mode,
)
# Create archive_status directory if necessary
archive_status_dir = os.path.join(recovery_info["wal_dest"], "archive_status")
try:
recovery_info["cmd"].create_dir_if_not_exists(archive_status_dir)
except FsOperationFailed as e:
output.error(
"unable to create the archive_status directory '%s': %s",
archive_status_dir,
e,
)
output.close_and_exit()
# As last step, analyse configuration files in order to spot
# harmful options. Barman performs automatic conversion of
# some options as well as notifying users of their existence.
#
# This operation is performed in three steps:
# 1) mapping
# 2) analysis
# 3) copy
output.info("Identify dangerous settings in destination directory.")
self._map_temporary_config_files(recovery_info, backup_info, remote_command)
self._analyse_temporary_config_files(recovery_info)
self._copy_temporary_config_files(dest, remote_command, recovery_info)
return recovery_info
def _setup(self, backup_info, remote_command, dest):
"""
Prepare the recovery_info dictionary for the recovery, as well
as temporary working directory
:param barman.infofile.LocalBackupInfo backup_info: representation of a
backup
:param str remote_command: ssh command for remote connection
:return dict: recovery_info dictionary, holding the basic values for a
recovery
"""
# Calculate the name of the WAL directory
if backup_info.version < 100000:
wal_dest = os.path.join(dest, "pg_xlog")
else:
wal_dest = os.path.join(dest, "pg_wal")
tempdir = tempfile.mkdtemp(prefix="barman_recovery-")
self.temp_dirs.append(tempdir)
recovery_info = {
"cmd": None,
"recovery_dest": "local",
"rsync": None,
"configuration_files": [],
"destination_path": dest,
"temporary_configuration_files": [],
"tempdir": tempdir,
"is_pitr": False,
"wal_dest": wal_dest,
"get_wal": RecoveryOptions.GET_WAL in self.config.recovery_options,
}
# A map that will keep track of the results of the recovery.
# Used for output generation
results = {
"changes": [],
"warnings": [],
"delete_barman_wal": False,
"missing_files": [],
"get_wal": False,
"recovery_start_time": datetime.datetime.now(),
}
recovery_info["results"] = results
# Set up a list of configuration files
recovery_info["configuration_files"].append("postgresql.conf")
if backup_info.version >= 90400:
recovery_info["configuration_files"].append("postgresql.auto.conf")
# Identify the file holding the recovery configuration
results["recovery_configuration_file"] = "postgresql.auto.conf"
if backup_info.version < 120000:
results["recovery_configuration_file"] = "recovery.conf"
# Handle remote recovery options
if remote_command:
recovery_info["recovery_dest"] = "remote"
recovery_info["rsync"] = RsyncPgData(
path=self.server.path,
ssh=remote_command,
bwlimit=self.config.bandwidth_limit,
network_compression=self.config.network_compression,
)
try:
# create a UnixRemoteCommand obj if is a remote recovery
recovery_info["cmd"] = UnixRemoteCommand(
remote_command, path=self.server.path
)
except FsOperationFailed:
output.error(
"Unable to connect to the target host using the command '%s'",
remote_command,
)
output.close_and_exit()
else:
# if is a local recovery create a UnixLocalCommand
recovery_info["cmd"] = UnixLocalCommand()
return recovery_info
def _set_pitr_targets(
self,
recovery_info,
backup_info,
dest,
target_name,
target_time,
target_tli,
target_xid,
target_lsn,
target_immediate,
target_action,
):
"""
Set PITR targets - as specified by the user
:param dict recovery_info: Dictionary containing all the recovery
parameters
:param barman.infofile.LocalBackupInfo backup_info: representation of a
backup
:param str dest: destination directory of the recovery
:param str|None target_name: recovery target name for PITR
:param str|None target_time: recovery target time for PITR
:param str|None target_tli: recovery target timeline for PITR
:param str|None target_xid: recovery target transaction id for PITR
:param str|None target_lsn: recovery target LSN for PITR
:param bool|None target_immediate: end recovery as soon as consistency
is reached
:param str|None target_action: recovery target action for PITR
"""
target_epoch = None
target_datetime = None
d_immediate = backup_info.version >= 90400 and target_immediate
d_lsn = backup_info.version >= 100000 and target_lsn
d_tli = target_tli and target_tli != backup_info.timeline
# Detect PITR
if target_time or target_xid or d_tli or target_name or d_immediate or d_lsn:
recovery_info["is_pitr"] = True
targets = {}
if target_time:
try:
target_datetime = dateutil.parser.parse(target_time)
except ValueError as e:
raise RecoveryInvalidTargetException(
"Unable to parse the target time parameter %r: %s"
% (target_time, e)
)
except TypeError:
# this should not happen, but there is a known bug in
# dateutil.parser.parse() implementation
# ref: https://bugs.launchpad.net/dateutil/+bug/1247643
raise RecoveryInvalidTargetException(
"Unable to parse the target time parameter %r" % target_time
)
# If the parsed timestamp is naive, forces it to local timezone
if target_datetime.tzinfo is None:
target_datetime = target_datetime.replace(
tzinfo=dateutil.tz.tzlocal()
)
# Check if the target time is reachable from the
# selected backup
if backup_info.end_time > target_datetime:
raise RecoveryInvalidTargetException(
"The requested target time %s "
"is before the backup end time %s"
% (target_datetime, backup_info.end_time)
)
ms = target_datetime.microsecond / 1000000.0
target_epoch = time.mktime(target_datetime.timetuple()) + ms
targets["time"] = str(target_datetime)
if target_xid:
targets["xid"] = str(target_xid)
if d_lsn:
targets["lsn"] = str(d_lsn)
if d_tli and target_tli != backup_info.timeline:
targets["timeline"] = str(d_tli)
if target_name:
targets["name"] = str(target_name)
if d_immediate:
targets["immediate"] = d_immediate
# Manage the target_action option
if backup_info.version < 90100:
if target_action:
raise RecoveryTargetActionException(
"Illegal target action '%s' "
"for this version of PostgreSQL" % target_action
)
elif 90100 <= backup_info.version < 90500:
if target_action == "pause":
recovery_info["pause_at_recovery_target"] = "on"
elif target_action:
raise RecoveryTargetActionException(
"Illegal target action '%s' "
"for this version of PostgreSQL" % target_action
)
else:
if target_action in ("pause", "shutdown", "promote"):
recovery_info["recovery_target_action"] = target_action
elif target_action:
raise RecoveryTargetActionException(
"Illegal target action '%s' "
"for this version of PostgreSQL" % target_action
)
output.info(
"Doing PITR. Recovery target %s",
(", ".join(["%s: %r" % (k, v) for k, v in targets.items()])),
)
recovery_info["wal_dest"] = os.path.join(dest, "barman_wal")
# With a PostgreSQL version older than 8.4, it is the user's
# responsibility to delete the "barman_wal" directory as the
# restore_command option in recovery.conf is not supported
if backup_info.version < 80400 and not recovery_info["get_wal"]:
recovery_info["results"]["delete_barman_wal"] = True
else:
# Raise an error if target_lsn is used with a pgversion < 10
if backup_info.version < 100000:
if target_lsn:
raise RecoveryInvalidTargetException(
"Illegal use of recovery_target_lsn '%s' "
"for this version of PostgreSQL "
"(version 10 minimum required)" % target_lsn
)
if target_immediate:
raise RecoveryInvalidTargetException(
"Illegal use of recovery_target_immediate "
"for this version of PostgreSQL "
"(version 9.4 minimum required)"
)
if target_action:
raise RecoveryTargetActionException(
"Can't enable recovery target action when PITR is not required"
)
recovery_info["target_epoch"] = target_epoch
recovery_info["target_datetime"] = target_datetime
def _retrieve_safe_horizon(self, recovery_info, backup_info, dest):
"""
Retrieve the safe_horizon for smart copy
If the target directory contains a previous recovery, it is safe to
pick the least of the two backup "begin times" (the one we are
recovering now and the one previously recovered in the target
directory). Set the value in the given recovery_info dictionary.
:param dict recovery_info: Dictionary containing all the recovery
parameters
:param barman.infofile.LocalBackupInfo backup_info: a backup
representation
:param str dest: recovery destination directory
"""
# noinspection PyBroadException
try:
backup_begin_time = backup_info.begin_time
# Retrieve previously recovered backup metadata (if available)
dest_info_txt = recovery_info["cmd"].get_file_content(
os.path.join(dest, ".barman-recover.info")
)
dest_info = LocalBackupInfo(
self.server, info_file=BytesIO(dest_info_txt.encode("utf-8"))
)
dest_begin_time = dest_info.begin_time
# Pick the earlier begin time. Both are tz-aware timestamps because
# BackupInfo class ensure it
safe_horizon = min(backup_begin_time, dest_begin_time)
output.info(
"Using safe horizon time for smart rsync copy: %s", safe_horizon
)
except FsOperationFailed as e:
# Setting safe_horizon to None will effectively disable
# the time-based part of smart_copy method. However it is still
# faster than running all the transfers with checksum enabled.
#
# FsOperationFailed means the .barman-recover.info is not available
# on destination directory
safe_horizon = None
_logger.warning(
"Unable to retrieve safe horizon time for smart rsync copy: %s", e
)
except Exception as e:
# Same as above, but something failed decoding .barman-recover.info
# or comparing times, so log the full traceback
safe_horizon = None
_logger.exception(
"Error retrieving safe horizon time for smart rsync copy: %s", e
)
recovery_info["safe_horizon"] = safe_horizon
def _prepare_tablespaces(self, backup_info, cmd, dest, tablespaces):
"""
Prepare the directory structure for required tablespaces,
taking care of tablespaces relocation, if requested.
:param barman.infofile.LocalBackupInfo backup_info: backup
representation
:param barman.fs.UnixLocalCommand cmd: Object for
filesystem interaction
:param str dest: destination dir for the recovery
:param dict tablespaces: dict of all the tablespaces and their location
"""
tblspc_dir = os.path.join(dest, "pg_tblspc")
try:
# check for pg_tblspc dir into recovery destination folder.
# if it does not exists, create it
cmd.create_dir_if_not_exists(tblspc_dir)
except FsOperationFailed as e:
output.error(
"unable to initialise tablespace directory '%s': %s", tblspc_dir, e
)
output.close_and_exit()
for item in backup_info.tablespaces:
# build the filename of the link under pg_tblspc directory
pg_tblspc_file = os.path.join(tblspc_dir, str(item.oid))
# by default a tablespace goes in the same location where
# it was on the source server when the backup was taken
location = item.location
# if a relocation has been requested for this tablespace,
# use the target directory provided by the user
if tablespaces and item.name in tablespaces:
location = tablespaces[item.name]
try:
# remove the current link in pg_tblspc, if it exists
cmd.delete_if_exists(pg_tblspc_file)
# create tablespace location, if does not exist
# (raise an exception if it is not possible)
cmd.create_dir_if_not_exists(location)
# check for write permissions on destination directory
cmd.check_write_permission(location)
# create symlink between tablespace and recovery folder
cmd.create_symbolic_link(location, pg_tblspc_file)
except FsOperationFailed as e:
output.error(
"unable to prepare '%s' tablespace (destination '%s'): %s",
item.name,
location,
e,
)
output.close_and_exit()
output.info("\t%s, %s, %s", item.oid, item.name, location)
def _backup_copy(
self,
backup_info,
dest,
tablespaces=None,
remote_command=None,
safe_horizon=None,
):
"""
Perform the actual copy of the base backup for recovery purposes
First, it copies one tablespace at a time, then the PGDATA directory.
Bandwidth limitation, according to configuration, is applied in
the process.
TODO: manage configuration files if outside PGDATA.
:param barman.infofile.LocalBackupInfo backup_info: the backup
to recover
:param str dest: the destination directory
:param dict[str,str]|None tablespaces: a tablespace
name -> location map (for relocation)
:param str|None remote_command: default None. The remote command to
recover the base backup, in case of remote backup.
:param datetime.datetime|None safe_horizon: anything after this time
has to be checked with checksum
"""
# Set a ':' prefix to remote destinations
dest_prefix = ""
if remote_command:
dest_prefix = ":"
# Create the copy controller object, specific for rsync,
# which will drive all the copy operations. Items to be
# copied are added before executing the copy() method
controller = RsyncCopyController(
path=self.server.path,
ssh_command=remote_command,
network_compression=self.config.network_compression,
safe_horizon=safe_horizon,
retry_times=self.config.basebackup_retry_times,
retry_sleep=self.config.basebackup_retry_sleep,
workers=self.config.parallel_jobs,
)
# Dictionary for paths to be excluded from rsync
exclude_and_protect = []
# Process every tablespace
if backup_info.tablespaces:
for tablespace in backup_info.tablespaces:
# By default a tablespace goes in the same location where
# it was on the source server when the backup was taken
location = tablespace.location
# If a relocation has been requested for this tablespace
# use the user provided target directory
if tablespaces and tablespace.name in tablespaces:
location = tablespaces[tablespace.name]
# If the tablespace location is inside the data directory,
# exclude and protect it from being deleted during
# the data directory copy
if location.startswith(dest):
exclude_and_protect += [location[len(dest) :]]
# Exclude and protect the tablespace from being deleted during
# the data directory copy
exclude_and_protect.append("/pg_tblspc/%s" % tablespace.oid)
# Add the tablespace directory to the list of objects
# to be copied by the controller
controller.add_directory(
label=tablespace.name,
src="%s/" % backup_info.get_data_directory(tablespace.oid),
dst=dest_prefix + location,
bwlimit=self.config.get_bwlimit(tablespace),
item_class=controller.TABLESPACE_CLASS,
)
# Add the PGDATA directory to the list of objects to be copied
# by the controller
controller.add_directory(
label="pgdata",
src="%s/" % backup_info.get_data_directory(),
dst=dest_prefix + dest,
bwlimit=self.config.get_bwlimit(),
exclude=[
"/pg_log/*",
"/log/*",
"/pg_xlog/*",
"/pg_wal/*",
"/postmaster.pid",
"/recovery.conf",
"/tablespace_map",
],
exclude_and_protect=exclude_and_protect,
item_class=controller.PGDATA_CLASS,
)
# TODO: Manage different location for configuration files
# TODO: that were not within the data directory
# Execute the copy
try:
controller.copy()
# TODO: Improve the exception output
except CommandFailedException as e:
msg = "data transfer failure"
raise DataTransferFailure.from_command_error("rsync", e, msg)
def _xlog_copy(self, required_xlog_files, wal_dest, remote_command):
"""
Restore WAL segments
:param required_xlog_files: list of all required WAL files
:param wal_dest: the destination directory for xlog recover
:param remote_command: default None. The remote command to recover
the xlog, in case of remote backup.
"""
# List of required WAL files partitioned by containing directory
xlogs = collections.defaultdict(list)
# add '/' suffix to ensure it is a directory
wal_dest = "%s/" % wal_dest
# Map of every compressor used with any WAL file in the archive,
# to be used during this recovery
compressors = {}
compression_manager = self.backup_manager.compression_manager
# Fill xlogs and compressors maps from required_xlog_files
for wal_info in required_xlog_files:
hashdir = xlog.hash_dir(wal_info.name)
xlogs[hashdir].append(wal_info)
# If a compressor is required, make sure it exists in the cache
if (
wal_info.compression is not None
and wal_info.compression not in compressors
):
compressors[wal_info.compression] = compression_manager.get_compressor(
compression=wal_info.compression
)
rsync = RsyncPgData(
path=self.server.path,
ssh=remote_command,
bwlimit=self.config.bandwidth_limit,
network_compression=self.config.network_compression,
)
# If compression is used and this is a remote recovery, we need a
# temporary directory where to spool uncompressed files,
# otherwise we either decompress every WAL file in the local
# destination, or we ship the uncompressed file remotely
if compressors:
if remote_command:
# Decompress to a temporary spool directory
wal_decompression_dest = tempfile.mkdtemp(prefix="barman_wal-")
else:
# Decompress directly to the destination directory
wal_decompression_dest = wal_dest
# Make sure wal_decompression_dest exists
mkpath(wal_decompression_dest)
else:
# If no compression
wal_decompression_dest = None
if remote_command:
# If remote recovery tell rsync to copy them remotely
# add ':' prefix to mark it as remote
wal_dest = ":%s" % wal_dest
total_wals = sum(map(len, xlogs.values()))
partial_count = 0
for prefix in sorted(xlogs):
batch_len = len(xlogs[prefix])
partial_count += batch_len
source_dir = os.path.join(self.config.wals_directory, prefix)
_logger.info(
"Starting copy of %s WAL files %s/%s from %s to %s",
batch_len,
partial_count,
total_wals,
xlogs[prefix][0],
xlogs[prefix][-1],
)
# If at least one compressed file has been found, activate
# compression check and decompression for each WAL files
if compressors:
for segment in xlogs[prefix]:
dst_file = os.path.join(wal_decompression_dest, segment.name)
if segment.compression is not None:
compressors[segment.compression].decompress(
os.path.join(source_dir, segment.name), dst_file
)
else:
shutil.copy2(os.path.join(source_dir, segment.name), dst_file)
if remote_command:
try:
# Transfer the WAL files
rsync.from_file_list(
list(segment.name for segment in xlogs[prefix]),
wal_decompression_dest,
wal_dest,
)
except CommandFailedException as e:
msg = (
"data transfer failure while copying WAL files "
"to directory '%s'"
) % (wal_dest[1:],)
raise DataTransferFailure.from_command_error("rsync", e, msg)
# Cleanup files after the transfer
for segment in xlogs[prefix]:
file_name = os.path.join(wal_decompression_dest, segment.name)
try:
os.unlink(file_name)
except OSError as e:
output.warning(
"Error removing temporary file '%s': %s", file_name, e
)
else:
try:
rsync.from_file_list(
list(segment.name for segment in xlogs[prefix]),
"%s/" % os.path.join(self.config.wals_directory, prefix),
wal_dest,
)
except CommandFailedException as e:
msg = (
"data transfer failure while copying WAL files "
"to directory '%s'" % (wal_dest[1:],)
)
raise DataTransferFailure.from_command_error("rsync", e, msg)
_logger.info("Finished copying %s WAL files.", total_wals)
# Remove local decompression target directory if different from the
# destination directory (it happens when compression is in use during a
# remote recovery
if wal_decompression_dest and wal_decompression_dest != wal_dest:
shutil.rmtree(wal_decompression_dest)
def _generate_archive_status(
self, recovery_info, remote_command, required_xlog_files
):
"""
Populate the archive_status directory
:param dict recovery_info: Dictionary containing all the recovery
parameters
:param str remote_command: ssh command for remote connection
:param tuple required_xlog_files: list of required WAL segments
"""
if remote_command:
status_dir = recovery_info["tempdir"]
else:
status_dir = os.path.join(recovery_info["wal_dest"], "archive_status")
mkpath(status_dir)
for wal_info in required_xlog_files:
with open(os.path.join(status_dir, "%s.done" % wal_info.name), "a") as f:
f.write("")
if remote_command:
try:
recovery_info["rsync"](
"%s/" % status_dir,
":%s" % os.path.join(recovery_info["wal_dest"], "archive_status"),
)
except CommandFailedException as e:
output.error("unable to populate archive_status directory: %s", e)
output.close_and_exit()
def _generate_recovery_conf(
self,
recovery_info,
backup_info,
dest,
immediate,
exclusive,
remote_command,
target_name,
target_time,
target_tli,
target_xid,
target_lsn,
standby_mode,
):
"""
Generate recovery configuration for PITR
:param dict recovery_info: Dictionary containing all the recovery
parameters
:param barman.infofile.LocalBackupInfo backup_info: representation
of a backup
:param str dest: destination directory of the recovery
:param bool|None immediate: end recovery as soon as consistency
is reached
:param boolean exclusive: exclusive backup or concurrent
:param str remote_command: ssh command for remote connection
:param str target_name: recovery target name for PITR
:param str target_time: recovery target time for PITR
:param str target_tli: recovery target timeline for PITR
:param str target_xid: recovery target transaction id for PITR
:param str target_lsn: recovery target LSN for PITR
:param bool|None standby_mode: standby mode
"""
recovery_conf_lines = []
# If GET_WAL has been set, use the get-wal command to retrieve the
# required wal files. Otherwise use the unix command "cp" to copy
# them from the barman_wal directory
if recovery_info["get_wal"]:
partial_option = ""
if not standby_mode:
partial_option = "-P"
# We need to create the right restore command.
# If we are doing a remote recovery,
# the barman-cli package is REQUIRED on the server that is hosting
# the PostgreSQL server.
# We use the machine FQDN and the barman_user
# setting to call the barman-wal-restore correctly.
# If local recovery, we use barman directly, assuming
# the postgres process will be executed with the barman user.
# It MUST to be reviewed by the user in any case.
if remote_command:
fqdn = socket.getfqdn()
recovery_conf_lines.append(
"# The 'barman-wal-restore' command "
"is provided in the 'barman-cli' package"
)
recovery_conf_lines.append(
"restore_command = 'barman-wal-restore %s -U %s "
"%s %s %%f %%p'"
% (partial_option, self.config.config.user, fqdn, self.config.name)
)
else:
recovery_conf_lines.append(
"# The 'barman get-wal' command "
"must run as '%s' user" % self.config.config.user
)
recovery_conf_lines.append(
"restore_command = 'sudo -u %s "
"barman get-wal %s %s %%f > %%p'"
% (self.config.config.user, partial_option, self.config.name)
)
recovery_info["results"]["get_wal"] = True
else:
recovery_conf_lines.append("restore_command = 'cp barman_wal/%f %p'")
if backup_info.version >= 80400 and not recovery_info["get_wal"]:
recovery_conf_lines.append("recovery_end_command = 'rm -fr barman_wal'")
# Writes recovery target
if target_time:
recovery_conf_lines.append("recovery_target_time = '%s'" % target_time)
if target_xid:
recovery_conf_lines.append("recovery_target_xid = '%s'" % target_xid)
if target_lsn:
recovery_conf_lines.append("recovery_target_lsn = '%s'" % target_lsn)
if target_name:
recovery_conf_lines.append("recovery_target_name = '%s'" % target_name)
# TODO: log a warning if PostgreSQL < 9.4 and --immediate
if backup_info.version >= 90400 and immediate:
recovery_conf_lines.append("recovery_target = 'immediate'")
# Manage what happens after recovery target is reached
if (target_xid or target_time or target_lsn) and exclusive:
recovery_conf_lines.append(
"recovery_target_inclusive = '%s'" % (not exclusive)
)
if target_tli:
recovery_conf_lines.append("recovery_target_timeline = %s" % target_tli)
# Write recovery target action
if "pause_at_recovery_target" in recovery_info:
recovery_conf_lines.append(
"pause_at_recovery_target = '%s'"
% recovery_info["pause_at_recovery_target"]
)
if "recovery_target_action" in recovery_info:
recovery_conf_lines.append(
"recovery_target_action = '%s'"
% recovery_info["recovery_target_action"]
)
# Set the standby mode
if backup_info.version >= 120000:
signal_file = "recovery.signal"
if standby_mode:
signal_file = "standby.signal"
if remote_command:
recovery_file = os.path.join(recovery_info["tempdir"], signal_file)
else:
recovery_file = os.path.join(dest, signal_file)
open(recovery_file, "ab").close()
recovery_info["auto_conf_append_lines"] = recovery_conf_lines
else:
if standby_mode:
recovery_conf_lines.append("standby_mode = 'on'")
if remote_command:
recovery_file = os.path.join(recovery_info["tempdir"], "recovery.conf")
else:
recovery_file = os.path.join(dest, "recovery.conf")
with open(recovery_file, "wb") as recovery:
recovery.write(("\n".join(recovery_conf_lines) + "\n").encode("utf-8"))
if remote_command:
plain_rsync = RsyncPgData(
path=self.server.path,
ssh=remote_command,
bwlimit=self.config.bandwidth_limit,
network_compression=self.config.network_compression,
)
try:
plain_rsync.from_file_list(
[os.path.basename(recovery_file)],
recovery_info["tempdir"],
":%s" % dest,
)
except CommandFailedException as e:
output.error(
"remote copy of %s failed: %s", os.path.basename(recovery_file), e
)
output.close_and_exit()
def _map_temporary_config_files(self, recovery_info, backup_info, remote_command):
"""
Map configuration files, by filling the 'temporary_configuration_files'
array, depending on remote or local recovery. This array will be used
by the subsequent methods of the class.
:param dict recovery_info: Dictionary containing all the recovery
parameters
:param barman.infofile.LocalBackupInfo backup_info: a backup
representation
:param str remote_command: ssh command for remote recovery
"""
# Cycle over postgres configuration files which my be missing.
# If a file is missing, we will be unable to restore it and
# we will warn the user.
# This can happen if we are using pg_basebackup and
# a configuration file is located outside the data dir.
# This is not an error condition, so we check also for
# `pg_ident.conf` which is an optional file.
hardcoded_files = ["pg_hba.conf", "pg_ident.conf"]
conf_files = recovery_info["configuration_files"] + hardcoded_files
for conf_file in conf_files:
source_path = os.path.join(backup_info.get_data_directory(), conf_file)
if not os.path.exists(source_path):
recovery_info["results"]["missing_files"].append(conf_file)
# Remove the file from the list of configuration files
if conf_file in recovery_info["configuration_files"]:
recovery_info["configuration_files"].remove(conf_file)
for conf_file in recovery_info["configuration_files"]:
if remote_command:
# If the recovery is remote, copy the postgresql.conf
# file in a temp dir
# Otherwise we can modify the postgresql.conf file
# in the destination directory.
conf_file_path = os.path.join(recovery_info["tempdir"], conf_file)
shutil.copy2(
os.path.join(backup_info.get_data_directory(), conf_file),
conf_file_path,
)
else:
# Otherwise use the local destination path.
conf_file_path = os.path.join(
recovery_info["destination_path"], conf_file
)
recovery_info["temporary_configuration_files"].append(conf_file_path)
if backup_info.version >= 120000:
# Make sure 'postgresql.auto.conf' file exists in
# recovery_info['temporary_configuration_files'] because
# the recovery settings will end up there
conf_file = "postgresql.auto.conf"
if conf_file not in recovery_info["configuration_files"]:
if remote_command:
conf_file_path = os.path.join(recovery_info["tempdir"], conf_file)
else:
conf_file_path = os.path.join(
recovery_info["destination_path"], conf_file
)
# Touch the file into existence
open(conf_file_path, "ab").close()
recovery_info["temporary_configuration_files"].append(conf_file_path)
def _analyse_temporary_config_files(self, recovery_info):
"""
Analyse temporary configuration files and identify dangerous options
Mark all the dangerous options for the user to review. This procedure
also changes harmful options such as 'archive_command'.
:param dict recovery_info: dictionary holding all recovery parameters
"""
results = recovery_info["results"]
# Check for dangerous options inside every config file
for conf_file in recovery_info["temporary_configuration_files"]:
append_lines = None
if conf_file.endswith("postgresql.auto.conf"):
append_lines = recovery_info.get("auto_conf_append_lines")
# Identify and comment out dangerous options, replacing them with
# the appropriate values
results["changes"] += self._pg_config_mangle(
conf_file, self.MANGLE_OPTIONS, "%s.origin" % conf_file, append_lines
)
# Identify dangerous options and warn users about their presence
results["warnings"] += self._pg_config_detect_possible_issues(conf_file)
def _copy_temporary_config_files(self, dest, remote_command, recovery_info):
"""
Copy modified configuration files using rsync in case of
remote recovery
:param str dest: destination directory of the recovery
:param str remote_command: ssh command for remote connection
:param dict recovery_info: Dictionary containing all the recovery
parameters
"""
if remote_command:
# If this is a remote recovery, rsync the modified files from the
# temporary local directory to the remote destination directory.
file_list = []
for conf_file in recovery_info["configuration_files"]:
file_list.append("%s" % conf_file)
file_list.append("%s.origin" % conf_file)
try:
recovery_info["rsync"].from_file_list(
file_list, recovery_info["tempdir"], ":%s" % dest
)
except CommandFailedException as e:
output.error("remote copy of configuration files failed: %s", e)
output.close_and_exit()
def close(self):
"""
Cleanup operations for a recovery
"""
# Remove the temporary directories
for temp_dir in self.temp_dirs:
shutil.rmtree(temp_dir, ignore_errors=True)
self.temp_dirs = []
def _pg_config_mangle(
self, filename, settings, backup_filename=None, append_lines=None
):
"""
This method modifies the given PostgreSQL configuration file,
commenting out the given settings, and adding the ones generated by
Barman.
If backup_filename is passed, keep a backup copy.
:param filename: the PostgreSQL configuration file
:param settings: dictionary of settings to be mangled
:param backup_filename: config file backup copy. Default is None.
"""
# Read the full content of the file in memory
with open(filename, "rb") as f:
content = f.readlines()
# Rename the original file to backup_filename or to a temporary name
# if backup_filename is missing. We need to keep it to preserve
# permissions.
if backup_filename:
orig_filename = backup_filename
else:
orig_filename = "%s.config_mangle.old" % filename
shutil.move(filename, orig_filename)
# Write the mangled content
mangled = []
with open(filename, "wb") as f:
last_line = None
for l_number, line in enumerate(content):
rm = PG_CONF_SETTING_RE.match(line.decode("utf-8"))
if rm:
key = rm.group(1)
if key in settings:
value = settings[key]
f.write("#BARMAN#".encode("utf-8") + line)
# If value is None, simply comment the old line
if value is not None:
changes = "%s = %s\n" % (key, value)
f.write(changes.encode("utf-8"))
mangled.append(
Assertion._make(
[os.path.basename(f.name), l_number, key, value]
)
)
continue
last_line = line
f.write(line)
# Append content of append_lines array
if append_lines:
# Ensure we have end of line character at the end of the file before adding new lines
if last_line and last_line[-1] != "\n".encode("utf-8"):
f.write("\n".encode("utf-8"))
f.write(("\n".join(append_lines) + "\n").encode("utf-8"))
# Restore original permissions
shutil.copymode(orig_filename, filename)
# If a backup copy of the file is not requested,
# unlink the orig file
if not backup_filename:
os.unlink(orig_filename)
return mangled
def _pg_config_detect_possible_issues(self, filename):
"""
This method looks for any possible issue with PostgreSQL
location options such as data_directory, config_file, etc.
It returns a dictionary with the dangerous options that
have been found.
:param filename: the Postgres configuration file
"""
clashes = []
with open(filename) as f:
content = f.readlines()
# Read line by line and identify dangerous options
for l_number, line in enumerate(content):
rm = PG_CONF_SETTING_RE.match(line)
if rm:
key = rm.group(1)
if key in self.DANGEROUS_OPTIONS:
clashes.append(
Assertion._make(
[os.path.basename(f.name), l_number, key, rm.group(2)]
)
)
return clashes
barman-2.18/barman/copy_controller.py 0000644 0006212 0006212 00000132447 14172556763 016142 0 ustar 0000000 0000000 # -*- coding: utf-8 -*-
# © Copyright EnterpriseDB UK Limited 2011-2022
#
# This file is part of Barman.
#
# Barman is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Barman is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Barman. If not, see .
"""
Copy controller module
A copy controller will handle the copy between a series of files and directory,
and their final destination.
"""
import collections
import datetime
import logging
import os.path
import re
import shutil
import signal
import tempfile
from functools import partial
from multiprocessing import Lock, Pool
import dateutil.tz
from barman.command_wrappers import RsyncPgData
from barman.exceptions import CommandFailedException, RsyncListFilesFailure
from barman.utils import human_readable_timedelta, total_seconds
_logger = logging.getLogger(__name__)
_worker_callable = None
"""
Global variable containing a callable used to execute the jobs.
Initialized by `_init_worker` and used by `_run_worker` function.
This variable must be None outside a multiprocessing worker Process.
"""
# Parallel copy bucket size (10GB)
BUCKET_SIZE = 1024 * 1024 * 1024 * 10
def _init_worker(func):
"""
Store the callable used to execute jobs passed to `_run_worker` function
:param callable func: the callable to invoke for every job
"""
global _worker_callable
_worker_callable = func
def _run_worker(job):
"""
Execute a job using the callable set using `_init_worker` function
:param _RsyncJob job: the job to be executed
"""
global _worker_callable
assert (
_worker_callable is not None
), "Worker has not been initialized with `_init_worker`"
# This is the entrypoint of the worker process. Since the KeyboardInterrupt
# exceptions is handled by the main process, let's forget about Ctrl-C
# here.
# When the parent process will receive a KeyboardInterrupt, it will ask
# the pool to terminate its workers and then terminate itself.
signal.signal(signal.SIGINT, signal.SIG_IGN)
return _worker_callable(job)
class _RsyncJob(object):
"""
A job to be executed by a worker Process
"""
def __init__(self, item_idx, description, id=None, file_list=None, checksum=None):
"""
:param int item_idx: The index of copy item containing this job
:param str description: The description of the job, used for logging
:param int id: Job ID (as in bucket)
:param list[RsyncCopyController._FileItem] file_list: Path to the file
containing the file list
:param bool checksum: Whether to force the checksum verification
"""
self.id = id
self.item_idx = item_idx
self.description = description
self.file_list = file_list
self.checksum = checksum
# Statistics
self.copy_start_time = None
self.copy_end_time = None
class _FileItem(collections.namedtuple("_FileItem", "mode size date path")):
"""
This named tuple is used to store the content each line of the output
of a "rsync --list-only" call
"""
class _RsyncCopyItem(object):
"""
Internal data object that contains the information about one of the items
that have to be copied during a RsyncCopyController run.
"""
def __init__(
self,
label,
src,
dst,
exclude=None,
exclude_and_protect=None,
include=None,
is_directory=False,
bwlimit=None,
reuse=None,
item_class=None,
optional=False,
):
"""
The "label" parameter is meant to be used for error messages
and logging.
If "src" or "dst" content begin with a ':' character, it is a remote
path. Only local paths are supported in "reuse" argument.
If "reuse" parameter is provided and is not None, it is used to
implement the incremental copy. This only works if "is_directory" is
True
:param str label: a symbolic name for this item
:param str src: source directory.
:param str dst: destination directory.
:param list[str] exclude: list of patterns to be excluded from the
copy. The destination will be deleted if present.
:param list[str] exclude_and_protect: list of patterns to be excluded
from the copy. The destination will be preserved if present.
:param list[str] include: list of patterns to be included in the
copy even if excluded.
:param bool is_directory: Whether the item points to a directory.
:param bwlimit: bandwidth limit to be enforced. (KiB)
:param str|None reuse: the reference path for incremental mode.
:param str|None item_class: If specified carries a meta information
about what the object to be copied is.
:param bool optional: Whether a failure copying this object should be
treated as a fatal failure. This only works if "is_directory" is
False
"""
self.label = label
self.src = src
self.dst = dst
self.exclude = exclude
self.exclude_and_protect = exclude_and_protect
self.include = include
self.is_directory = is_directory
self.bwlimit = bwlimit
self.reuse = reuse
self.item_class = item_class
self.optional = optional
# Attributes that will e filled during the analysis
self.temp_dir = None
self.dir_file = None
self.exclude_and_protect_file = None
self.safe_list = None
self.check_list = None
# Statistics
self.analysis_start_time = None
self.analysis_end_time = None
# Ensure that the user specified the item class, since it is mandatory
# to correctly handle the item
assert self.item_class
def __str__(self):
# Prepare strings for messages
formatted_class = self.item_class
formatted_name = self.src
if self.src.startswith(":"):
formatted_class = "remote " + self.item_class
formatted_name = self.src[1:]
formatted_class += " directory" if self.is_directory else " file"
# Log the operation that is being executed
if self.item_class in (
RsyncCopyController.PGDATA_CLASS,
RsyncCopyController.PGCONTROL_CLASS,
):
return "%s: %s" % (formatted_class, formatted_name)
else:
return "%s '%s': %s" % (formatted_class, self.label, formatted_name)
class RsyncCopyController(object):
"""
Copy a list of files and directory to their final destination.
"""
# Constants to be used as "item_class" values
PGDATA_CLASS = "PGDATA"
TABLESPACE_CLASS = "tablespace"
PGCONTROL_CLASS = "pg_control"
CONFIG_CLASS = "config"
# This regular expression is used to parse each line of the output
# of a "rsync --list-only" call. This regexp has been tested with any known
# version of upstream rsync that is supported (>= 3.0.4)
LIST_ONLY_RE = re.compile(
r"""
^ # start of the line
# capture the mode (es. "-rw-------")
(?P[-\w]+)
\s+
# size is an integer
(?P\d+)
\s+
# The date field can have two different form
(?P
# "2014/06/05 18:00:00" if the sending rsync is compiled
# with HAVE_STRFTIME
[\d/]+\s+[\d:]+
|
# "Thu Jun 5 18:00:00 2014" otherwise
\w+\s+\w+\s+\d+\s+[\d:]+\s+\d+
)
\s+
# all the remaining characters are part of filename
(?P.+)
$ # end of the line
""",
re.VERBOSE,
)
# This regular expression is used to ignore error messages regarding
# vanished files that are not really an error. It is used because
# in some cases rsync reports it with exit code 23 which could also mean
# a fatal error
VANISHED_RE = re.compile(
r"""
^ # start of the line
(
# files which vanished before rsync start
rsync:\ link_stat\ ".+"\ failed:\ No\ such\ file\ or\ directory\ \(2\)
|
# files which vanished after rsync start
file\ has\ vanished:\ ".+"
|
# files which have been truncated during transfer
rsync:\ read\ errors\ mapping\ ".+":\ No\ data\ available\ \(61\)
|
# final summary
rsync\ error:\ .* \(code\ 23\)\ at\ main\.c\(\d+\)
\ \[(generator|receiver|sender)=[^\]]+\]
)
$ # end of the line
""",
re.VERBOSE + re.IGNORECASE,
)
def __init__(
self,
path=None,
ssh_command=None,
ssh_options=None,
network_compression=False,
reuse_backup=None,
safe_horizon=None,
exclude=None,
retry_times=0,
retry_sleep=0,
workers=1,
):
"""
:param str|None path: the PATH where rsync executable will be searched
:param str|None ssh_command: the ssh executable to be used
to access remote paths
:param list[str]|None ssh_options: list of ssh options to be used
to access remote paths
:param boolean network_compression: whether to use the network
compression
:param str|None reuse_backup: if "link" or "copy" enables
the incremental copy feature
:param datetime.datetime|None safe_horizon: if set, assumes that every
files older than it are save to copy without checksum verification.
:param list[str]|None exclude: list of patterns to be excluded
from the copy
:param int retry_times: The number of times to retry a failed operation
:param int retry_sleep: Sleep time between two retry
:param int workers: The number of parallel copy workers
"""
super(RsyncCopyController, self).__init__()
self.path = path
self.ssh_command = ssh_command
self.ssh_options = ssh_options
self.network_compression = network_compression
self.reuse_backup = reuse_backup
self.safe_horizon = safe_horizon
self.exclude = exclude
self.retry_times = retry_times
self.retry_sleep = retry_sleep
self.workers = workers
self._logger_lock = Lock()
# Assume we are running with a recent rsync (>= 3.1)
self.rsync_has_ignore_missing_args = True
self.item_list = []
"""List of items to be copied"""
self.rsync_cache = {}
"""A cache of RsyncPgData objects"""
# Attributes used for progress reporting
self.total_steps = None
"""Total number of steps"""
self.current_step = None
"""Current step number"""
self.temp_dir = None
"""Temp dir used to store the status during the copy"""
# Statistics
self.jobs_done = None
"""Already finished jobs list"""
self.copy_start_time = None
"""Copy start time"""
self.copy_end_time = None
"""Copy end time"""
def add_directory(
self,
label,
src,
dst,
exclude=None,
exclude_and_protect=None,
include=None,
bwlimit=None,
reuse=None,
item_class=None,
):
"""
Add a directory that we want to copy.
If "src" or "dst" content begin with a ':' character, it is a remote
path. Only local paths are supported in "reuse" argument.
If "reuse" parameter is provided and is not None, it is used to
implement the incremental copy. This only works if "is_directory" is
True
:param str label: symbolic name to be used for error messages
and logging.
:param str src: source directory.
:param str dst: destination directory.
:param list[str] exclude: list of patterns to be excluded from the
copy. The destination will be deleted if present.
:param list[str] exclude_and_protect: list of patterns to be excluded
from the copy. The destination will be preserved if present.
:param list[str] include: list of patterns to be included in the
copy even if excluded.
:param bwlimit: bandwidth limit to be enforced. (KiB)
:param str|None reuse: the reference path for incremental mode.
:param str item_class: If specified carries a meta information about
what the object to be copied is.
"""
self.item_list.append(
_RsyncCopyItem(
label=label,
src=src,
dst=dst,
is_directory=True,
bwlimit=bwlimit,
reuse=reuse,
item_class=item_class,
optional=False,
exclude=exclude,
exclude_and_protect=exclude_and_protect,
include=include,
)
)
def add_file(self, label, src, dst, item_class=None, optional=False):
"""
Add a file that we want to copy
:param str label: symbolic name to be used for error messages
and logging.
:param str src: source directory.
:param str dst: destination directory.
:param str item_class: If specified carries a meta information about
what the object to be copied is.
:param bool optional: Whether a failure copying this object should be
treated as a fatal failure.
"""
self.item_list.append(
_RsyncCopyItem(
label=label,
src=src,
dst=dst,
is_directory=False,
bwlimit=None,
reuse=None,
item_class=item_class,
optional=optional,
)
)
def _rsync_factory(self, item):
"""
Build the RsyncPgData object required for copying the provided item
:param _RsyncCopyItem item: information about a copy operation
:rtype: RsyncPgData
"""
# If the object already exists, use it
if item in self.rsync_cache:
return self.rsync_cache[item]
# Prepare the command arguments
args = self._reuse_args(item.reuse)
# Merge the global exclude with the one into the item object
if self.exclude and item.exclude:
exclude = self.exclude + item.exclude
else:
exclude = self.exclude or item.exclude
# Using `--ignore-missing-args` could fail in case
# the local or the remote rsync is older than 3.1.
# In that case we expect that during the analyze phase
# we get an error. The analyze code must catch that error
# and retry after flushing the rsync cache.
if self.rsync_has_ignore_missing_args:
args.append("--ignore-missing-args")
# TODO: remove debug output or use it to progress tracking
# By adding a double '--itemize-changes' option, the rsync
# output will contain the full list of files that have been
# touched, even those that have not changed
args.append("--itemize-changes")
args.append("--itemize-changes")
# Build the rsync object that will execute the copy
rsync = RsyncPgData(
path=self.path,
ssh=self.ssh_command,
ssh_options=self.ssh_options,
args=args,
bwlimit=item.bwlimit,
network_compression=self.network_compression,
exclude=exclude,
exclude_and_protect=item.exclude_and_protect,
include=item.include,
retry_times=self.retry_times,
retry_sleep=self.retry_sleep,
retry_handler=partial(self._retry_handler, item),
)
self.rsync_cache[item] = rsync
return rsync
def _rsync_set_pre_31_mode(self):
"""
Stop using `--ignore-missing-args` and restore rsync < 3.1
compatibility
"""
_logger.info(
"Detected rsync version less than 3.1. "
"top using '--ignore-missing-args' argument."
)
self.rsync_has_ignore_missing_args = False
self.rsync_cache.clear()
def copy(self):
"""
Execute the actual copy
"""
# Store the start time
self.copy_start_time = datetime.datetime.now()
# Create a temporary directory to hold the file lists.
self.temp_dir = tempfile.mkdtemp(suffix="", prefix="barman-")
# The following try block is to make sure the temporary directory
# will be removed on exit and all the pool workers
# have been terminated.
pool = None
try:
# Initialize the counters used by progress reporting
self._progress_init()
_logger.info("Copy started (safe before %r)", self.safe_horizon)
# Execute some preliminary steps for each item to be copied
for item in self.item_list:
# The initial preparation is necessary only for directories
if not item.is_directory:
continue
# Store the analysis start time
item.analysis_start_time = datetime.datetime.now()
# Analyze the source and destination directory content
_logger.info(self._progress_message("[global] analyze %s" % item))
self._analyze_directory(item)
# Prepare the target directories, removing any unneeded file
_logger.info(
self._progress_message(
"[global] create destination directories and delete "
"unknown files for %s" % item
)
)
self._create_dir_and_purge(item)
# Store the analysis end time
item.analysis_end_time = datetime.datetime.now()
# Init the list of jobs done. Every job will be added to this list
# once finished. The content will be used to calculate statistics
# about the copy process.
self.jobs_done = []
# The jobs are executed using a parallel processes pool
# Each job is generated by `self._job_generator`, it is executed by
# `_run_worker` using `self._execute_job`, which has been set
# calling `_init_worker` function during the Pool initialization.
pool = Pool(
processes=self.workers,
initializer=_init_worker,
initargs=(self._execute_job,),
)
for job in pool.imap_unordered(
_run_worker, self._job_generator(exclude_classes=[self.PGCONTROL_CLASS])
):
# Store the finished job for further analysis
self.jobs_done.append(job)
# The PGCONTROL_CLASS items must always be copied last
for job in pool.imap_unordered(
_run_worker, self._job_generator(include_classes=[self.PGCONTROL_CLASS])
):
# Store the finished job for further analysis
self.jobs_done.append(job)
except KeyboardInterrupt:
_logger.info(
"Copy interrupted by the user (safe before %s)", self.safe_horizon
)
raise
except BaseException:
_logger.info("Copy failed (safe before %s)", self.safe_horizon)
raise
else:
_logger.info("Copy finished (safe before %s)", self.safe_horizon)
finally:
# The parent process may have finished naturally or have been
# interrupted by an exception (i.e. due to a copy error or
# the user pressing Ctrl-C).
# At this point we must make sure that all the workers have been
# correctly terminated before continuing.
if pool:
pool.terminate()
pool.join()
# Clean up the temp dir, any exception raised here is logged
# and discarded to not clobber an eventual exception being handled.
try:
shutil.rmtree(self.temp_dir)
except EnvironmentError as e:
_logger.error("Error cleaning up '%s' (%s)", self.temp_dir, e)
self.temp_dir = None
# Store the end time
self.copy_end_time = datetime.datetime.now()
def _job_generator(self, include_classes=None, exclude_classes=None):
"""
Generate the jobs to be executed by the workers
:param list[str]|None include_classes: If not none, copy only the items
which have one of the specified classes.
:param list[str]|None exclude_classes: If not none, skip all items
which have one of the specified classes.
:rtype: iter[_RsyncJob]
"""
for item_idx, item in enumerate(self.item_list):
# Skip items of classes which are not required
if include_classes and item.item_class not in include_classes:
continue
if exclude_classes and item.item_class in exclude_classes:
continue
# If the item is a directory then copy it in two stages,
# otherwise copy it using a plain rsync
if item.is_directory:
# Copy the safe files using the default rsync algorithm
msg = self._progress_message("[%%s] %%s copy safe files from %s" % item)
phase_skipped = True
for i, bucket in enumerate(self._fill_buckets(item.safe_list)):
phase_skipped = False
yield _RsyncJob(
item_idx,
id=i,
description=msg,
file_list=bucket,
checksum=False,
)
if phase_skipped:
_logger.info(msg, "global", "skipping")
# Copy the check files forcing rsync to verify the checksum
msg = self._progress_message(
"[%%s] %%s copy files with checksum from %s" % item
)
phase_skipped = True
for i, bucket in enumerate(self._fill_buckets(item.check_list)):
phase_skipped = False
yield _RsyncJob(
item_idx, id=i, description=msg, file_list=bucket, checksum=True
)
if phase_skipped:
_logger.info(msg, "global", "skipping")
else:
# Copy the file using plain rsync
msg = self._progress_message("[%%s] %%s copy %s" % item)
yield _RsyncJob(item_idx, description=msg)
def _fill_buckets(self, file_list):
"""
Generate buckets for parallel copy
:param list[_FileItem] file_list: list of file to transfer
:rtype: iter[list[_FileItem]]
"""
# If there is only one worker, fall back to copying all file at once
if self.workers < 2:
yield file_list
return
# Create `self.workers` buckets
buckets = [[] for _ in range(self.workers)]
bucket_sizes = [0 for _ in range(self.workers)]
pos = -1
# Sort the list by size
for entry in sorted(file_list, key=lambda item: item.size):
# Try to fill the file in a bucket
for i in range(self.workers):
pos = (pos + 1) % self.workers
new_size = bucket_sizes[pos] + entry.size
if new_size < BUCKET_SIZE:
bucket_sizes[pos] = new_size
buckets[pos].append(entry)
break
else:
# All the buckets are filled, so return them all
for i in range(self.workers):
if len(buckets[i]) > 0:
yield buckets[i]
# Clear the bucket
buckets[i] = []
bucket_sizes[i] = 0
# Put the current file in the first bucket
bucket_sizes[0] = entry.size
buckets[0].append(entry)
pos = 0
# Send all the remaining buckets
for i in range(self.workers):
if len(buckets[i]) > 0:
yield buckets[i]
def _execute_job(self, job):
"""
Execute a `_RsyncJob` in a worker process
:type job: _RsyncJob
"""
item = self.item_list[job.item_idx]
if job.id is not None:
bucket = "bucket %s" % job.id
else:
bucket = "global"
# Build the rsync object required for the copy
rsync = self._rsync_factory(item)
# Store the start time
job.copy_start_time = datetime.datetime.now()
# Write in the log that the job is starting
with self._logger_lock:
_logger.info(job.description, bucket, "starting")
if item.is_directory:
# A directory item must always have checksum and file_list set
assert (
job.file_list is not None
), "A directory item must not have a None `file_list` attribute"
assert (
job.checksum is not None
), "A directory item must not have a None `checksum` attribute"
# Generate a unique name for the file containing the list of files
file_list_path = os.path.join(
self.temp_dir,
"%s_%s_%s.list"
% (item.label, "check" if job.checksum else "safe", os.getpid()),
)
# Write the list, one path per line
with open(file_list_path, "w") as file_list:
for entry in job.file_list:
assert isinstance(entry, _FileItem), (
"expect %r to be a _FileItem" % entry
)
file_list.write(entry.path + "\n")
self._copy(
rsync,
item.src,
item.dst,
file_list=file_list_path,
checksum=job.checksum,
)
else:
# A file must never have checksum and file_list set
assert (
job.file_list is None
), "A file item must have a None `file_list` attribute"
assert (
job.checksum is None
), "A file item must have a None `checksum` attribute"
rsync(item.src, item.dst, allowed_retval=(0, 23, 24))
if rsync.ret == 23:
if item.optional:
_logger.warning("Ignoring error reading %s", item)
else:
raise CommandFailedException(
dict(ret=rsync.ret, out=rsync.out, err=rsync.err)
)
# Store the stop time
job.copy_end_time = datetime.datetime.now()
# Write in the log that the job is finished
with self._logger_lock:
_logger.info(
job.description,
bucket,
"finished (duration: %s)"
% human_readable_timedelta(job.copy_end_time - job.copy_start_time),
)
# Return the job to the caller, for statistics purpose
return job
def _progress_init(self):
"""
Init counters used by progress logging
"""
self.total_steps = 0
for item in self.item_list:
# Directories require 4 steps, files only one
if item.is_directory:
self.total_steps += 4
else:
self.total_steps += 1
self.current_step = 0
def _progress_message(self, msg):
"""
Log a message containing the progress
:param str msg: the message
:return srt: message to log
"""
self.current_step += 1
return "Copy step %s of %s: %s" % (self.current_step, self.total_steps, msg)
def _reuse_args(self, reuse_directory):
"""
If reuse_backup is 'copy' or 'link', build the rsync option to enable
the reuse, otherwise returns an empty list
:param str reuse_directory: the local path with data to be reused
:rtype: list[str]
"""
if self.reuse_backup in ("copy", "link") and reuse_directory is not None:
return ["--%s-dest=%s" % (self.reuse_backup, reuse_directory)]
else:
return []
def _retry_handler(self, item, command, args, kwargs, attempt, exc):
"""
:param _RsyncCopyItem item: The item that is being processed
:param RsyncPgData command: Command object being executed
:param list args: command args
:param dict kwargs: command kwargs
:param int attempt: attempt number (starting from 0)
:param CommandFailedException exc: the exception which caused the
failure
"""
_logger.warn("Failure executing rsync on %s (attempt %s)", item, attempt)
_logger.warn("Retrying in %s seconds", self.retry_sleep)
def _analyze_directory(self, item):
"""
Analyzes the status of source and destination directories identifying
the files that are safe from the point of view of a PostgreSQL backup.
The safe_horizon value is the timestamp of the beginning of the
older backup involved in copy (as source or destination). Any files
updated after that timestamp, must be checked as they could have been
modified during the backup - and we do not reply WAL files to update
them.
The destination directory must exist.
If the "safe_horizon" parameter is None, we cannot make any
assumptions about what can be considered "safe", so we must check
everything with checksums enabled.
If "ref" parameter is provided and is not None, it is looked up
instead of the "dst" dir. This is useful when we are copying files
using '--link-dest' and '--copy-dest' rsync options.
In this case, both the "dst" and "ref" dir must exist and
the "dst" dir must be empty.
If source or destination path begin with a ':' character,
it is a remote path. Only local paths are supported in "ref" argument.
:param _RsyncCopyItem item: information about a copy operation
"""
# If reference is not set we use dst as reference path
ref = item.reuse
if ref is None:
ref = item.dst
# Make sure the ref path ends with a '/' or rsync will add the
# last path component to all the returned items during listing
if ref[-1] != "/":
ref += "/"
# Build a hash containing all files present on reference directory.
# Directories are not included
try:
ref_hash = {}
ref_has_content = False
for file_item in self._list_files(item, ref):
if file_item.path != "." and not (
item.label == "pgdata" and file_item.path == "pg_tblspc"
):
ref_has_content = True
if file_item.mode[0] != "d":
ref_hash[file_item.path] = file_item
except (CommandFailedException, RsyncListFilesFailure) as e:
# Here we set ref_hash to None, thus disable the code that marks as
# "safe matching" those destination files with different time or
# size, even if newer than "safe_horizon". As a result, all files
# newer than "safe_horizon" will be checked through checksums.
ref_hash = None
_logger.error(
"Unable to retrieve reference directory file list. "
"Using only source file information to decide which files"
" need to be copied with checksums enabled: %s" % e
)
# The 'dir.list' file will contain every directory in the
# source tree
item.dir_file = os.path.join(self.temp_dir, "%s_dir.list" % item.label)
dir_list = open(item.dir_file, "w+")
# The 'protect.list' file will contain a filter rule to protect
# each file present in the source tree. It will be used during
# the first phase to delete all the extra files on destination.
item.exclude_and_protect_file = os.path.join(
self.temp_dir, "%s_exclude_and_protect.filter" % item.label
)
exclude_and_protect_filter = open(item.exclude_and_protect_file, "w+")
if not ref_has_content:
# If the destination directory is empty then include all
# directories and exclude all files. This stops the rsync
# command which runs during the _create_dir_and_purge function
# from copying the entire contents of the source directory and
# ensures it only creates the directories.
exclude_and_protect_filter.write("+ */\n")
exclude_and_protect_filter.write("- *\n")
# The `safe_list` will contain all items older than
# safe_horizon, as well as files that we know rsync will
# check anyway due to a difference in mtime or size
item.safe_list = []
# The `check_list` will contain all items that need
# to be copied with checksum option enabled
item.check_list = []
for entry in self._list_files(item, item.src):
# If item is a directory, we only need to save it in 'dir.list'
if entry.mode[0] == "d":
dir_list.write(entry.path + "\n")
continue
# Add every file in the source path to the list of files
# to be protected from deletion ('exclude_and_protect.filter')
# But only if we know the destination directory is non-empty
if ref_has_content:
exclude_and_protect_filter.write("P /" + entry.path + "\n")
exclude_and_protect_filter.write("- /" + entry.path + "\n")
# If source item is older than safe_horizon,
# add it to 'safe.list'
if self.safe_horizon and entry.date < self.safe_horizon:
item.safe_list.append(entry)
continue
# If ref_hash is None, it means we failed to retrieve the
# destination file list. We assume the only safe way is to
# check every file that is older than safe_horizon
if ref_hash is None:
item.check_list.append(entry)
continue
# If source file differs by time or size from the matching
# destination, rsync will discover the difference in any case.
# It is then safe to skip checksum check here.
dst_item = ref_hash.get(entry.path, None)
if dst_item is None:
item.safe_list.append(entry)
continue
different_size = dst_item.size != entry.size
different_date = dst_item.date != entry.date
if different_size or different_date:
item.safe_list.append(entry)
continue
# All remaining files must be checked with checksums enabled
item.check_list.append(entry)
# Close all the control files
dir_list.close()
exclude_and_protect_filter.close()
def _create_dir_and_purge(self, item):
"""
Create destination directories and delete any unknown file
:param _RsyncCopyItem item: information about a copy operation
"""
# Build the rsync object required for the analysis
rsync = self._rsync_factory(item)
# Create directories and delete any unknown file
self._rsync_ignore_vanished_files(
rsync,
"--recursive",
"--delete",
"--files-from=%s" % item.dir_file,
"--filter",
"merge %s" % item.exclude_and_protect_file,
item.src,
item.dst,
check=True,
)
def _copy(self, rsync, src, dst, file_list, checksum=False):
"""
The method execute the call to rsync, using as source a
a list of files, and adding the the checksum option if required by the
caller.
:param Rsync rsync: the Rsync object used to retrieve the list of files
inside the directories
for copy purposes
:param str src: source directory
:param str dst: destination directory
:param str file_list: path to the file containing the sources for rsync
:param bool checksum: if checksum argument for rsync is required
"""
# Build the rsync call args
args = ["--files-from=%s" % file_list]
if checksum:
# Add checksum option if needed
args.append("--checksum")
self._rsync_ignore_vanished_files(rsync, src, dst, *args, check=True)
def _list_files(self, item, path):
"""
This method recursively retrieves a list of files contained in a
directory, either local or remote (if starts with ':')
:param _RsyncCopyItem item: information about a copy operation
:param str path: the path we want to inspect
:except CommandFailedException: if rsync call fails
:except RsyncListFilesFailure: if rsync output can't be parsed
"""
_logger.debug("list_files: %r", path)
# Build the rsync object required for the analysis
rsync = self._rsync_factory(item)
try:
# Use the --no-human-readable option to avoid digit groupings
# in "size" field with rsync >= 3.1.0.
# Ref: http://ftp.samba.org/pub/rsync/src/rsync-3.1.0-NEWS
rsync.get_output(
"--no-human-readable", "--list-only", "-r", path, check=True
)
except CommandFailedException:
# This could fail due to the local or the remote rsync
# older than 3.1. IF so, fallback to pre 3.1 mode
if self.rsync_has_ignore_missing_args and rsync.ret in (
12, # Error in rsync protocol data stream (remote)
1,
): # Syntax or usage error (local)
self._rsync_set_pre_31_mode()
# Recursive call, uses the compatibility mode
for item in self._list_files(item, path):
yield item
return
else:
raise
# Cache tzlocal object we need to build dates
tzinfo = dateutil.tz.tzlocal()
for line in rsync.out.splitlines():
line = line.rstrip()
match = self.LIST_ONLY_RE.match(line)
if match:
mode = match.group("mode")
# no exceptions here: the regexp forces 'size' to be an integer
size = int(match.group("size"))
try:
date_str = match.group("date")
# The date format has been validated by LIST_ONLY_RE.
# Use "2014/06/05 18:00:00" format if the sending rsync
# is compiled with HAVE_STRFTIME, otherwise use
# "Thu Jun 5 18:00:00 2014" format
if date_str[0].isdigit():
date = datetime.datetime.strptime(date_str, "%Y/%m/%d %H:%M:%S")
else:
date = datetime.datetime.strptime(
date_str, "%a %b %d %H:%M:%S %Y"
)
date = date.replace(tzinfo=tzinfo)
except (TypeError, ValueError):
# This should not happen, due to the regexp
msg = (
"Unable to parse rsync --list-only output line "
"(date): '%s'" % line
)
_logger.exception(msg)
raise RsyncListFilesFailure(msg)
path = match.group("path")
yield _FileItem(mode, size, date, path)
else:
# This is a hard error, as we are unable to parse the output
# of rsync. It can only happen with a modified or unknown
# rsync version (perhaps newer than 3.1?)
msg = "Unable to parse rsync --list-only output line: '%s'" % line
_logger.error(msg)
raise RsyncListFilesFailure(msg)
def _rsync_ignore_vanished_files(self, rsync, *args, **kwargs):
"""
Wrap an Rsync.get_output() call and ignore missing args
TODO: when rsync 3.1 will be widespread, replace this
with --ignore-missing-args argument
:param Rsync rsync: the Rsync object used to execute the copy
"""
kwargs["allowed_retval"] = (0, 23, 24)
rsync.get_output(*args, **kwargs)
# If return code is 23 and there is any error which doesn't match
# the VANISHED_RE regexp raise an error
if rsync.ret == 23 and rsync.err is not None:
for line in rsync.err.splitlines():
match = self.VANISHED_RE.match(line.rstrip())
if match:
continue
else:
_logger.error("First rsync error line: %s", line)
raise CommandFailedException(
dict(ret=rsync.ret, out=rsync.out, err=rsync.err)
)
return rsync.out, rsync.err
def statistics(self):
"""
Return statistics about the copy object.
:rtype: dict
"""
# This method can only run at the end of a non empty copy
assert self.copy_end_time
assert self.item_list
assert self.jobs_done
# Initialise the result calculating the total runtime
stat = {
"total_time": total_seconds(self.copy_end_time - self.copy_start_time),
"number_of_workers": self.workers,
"analysis_time_per_item": {},
"copy_time_per_item": {},
"serialized_copy_time_per_item": {},
}
# Calculate the time spent during the analysis of the items
analysis_start = None
analysis_end = None
for item in self.item_list:
# Some items don't require analysis
if not item.analysis_end_time:
continue
# Build a human readable name to refer to an item in the output
ident = item.label
if not analysis_start:
analysis_start = item.analysis_start_time
elif analysis_start > item.analysis_start_time:
analysis_start = item.analysis_start_time
if not analysis_end:
analysis_end = item.analysis_end_time
elif analysis_end < item.analysis_end_time:
analysis_end = item.analysis_end_time
stat["analysis_time_per_item"][ident] = total_seconds(
item.analysis_end_time - item.analysis_start_time
)
stat["analysis_time"] = total_seconds(analysis_end - analysis_start)
# Calculate the time spent per job
# WARNING: this code assumes that every item is copied separately,
# so it's strictly tied to the `_job_generator` method code
item_data = {}
for job in self.jobs_done:
# WARNING: the item contained in the job is not the same object
# contained in self.item_list, as it has gone through two
# pickling/unpickling cycle
# Build a human readable name to refer to an item in the output
ident = self.item_list[job.item_idx].label
# If this is the first time we see this item we just store the
# values from the job
if ident not in item_data:
item_data[ident] = {
"start": job.copy_start_time,
"end": job.copy_end_time,
"total_time": job.copy_end_time - job.copy_start_time,
}
else:
data = item_data[ident]
if data["start"] > job.copy_start_time:
data["start"] = job.copy_start_time
if data["end"] < job.copy_end_time:
data["end"] = job.copy_end_time
data["total_time"] += job.copy_end_time - job.copy_start_time
# Calculate the time spent copying
copy_start = None
copy_end = None
serialized_time = datetime.timedelta(0)
for ident in item_data:
data = item_data[ident]
if copy_start is None or copy_start > data["start"]:
copy_start = data["start"]
if copy_end is None or copy_end < data["end"]:
copy_end = data["end"]
stat["copy_time_per_item"][ident] = total_seconds(
data["end"] - data["start"]
)
stat["serialized_copy_time_per_item"][ident] = total_seconds(
data["total_time"]
)
serialized_time += data["total_time"]
# Store the total time spent by copying
stat["copy_time"] = total_seconds(copy_end - copy_start)
stat["serialized_copy_time"] = total_seconds(serialized_time)
return stat
barman-2.18/barman/cloud.py 0000644 0006212 0006212 00000203254 14172556763 014026 0 ustar 0000000 0000000 # -*- coding: utf-8 -*-
# © Copyright EnterpriseDB UK Limited 2018-2022
#
# This file is part of Barman.
#
# Barman is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Barman is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Barman. If not, see .
import collections
import copy
import datetime
import errno
import json
import logging
import multiprocessing
import operator
import os
import shutil
import signal
import tarfile
from abc import ABCMeta, abstractmethod, abstractproperty
from functools import partial
from io import BytesIO, RawIOBase
from tempfile import NamedTemporaryFile
from barman.annotations import KeepManagerMixinCloud
from barman.backup_executor import ConcurrentBackupStrategy, ExclusiveBackupStrategy
from barman.clients import cloud_compression
from barman.exceptions import BarmanException
from barman.fs import path_allowed
from barman.infofile import BackupInfo
from barman.postgres_plumbing import EXCLUDE_LIST, PGDATA_EXCLUDE_LIST
from barman.utils import (
BarmanEncoder,
force_str,
human_readable_timedelta,
pretty_size,
total_seconds,
with_metaclass,
)
from barman import xlog
try:
# Python 3.x
from queue import Empty as EmptyQueue
except ImportError:
# Python 2.x
from Queue import Empty as EmptyQueue
BUFSIZE = 16 * 1024
LOGGING_FORMAT = "%(asctime)s [%(process)s] %(levelname)s: %(message)s"
# Allowed compression algorithms
ALLOWED_COMPRESSIONS = {".gz": "gzip", ".bz2": "bzip2", ".snappy": "snappy"}
def configure_logging(config):
"""
Get a nicer output from the Python logging package
"""
verbosity = config.verbose - config.quiet
log_level = max(logging.WARNING - verbosity * 10, logging.DEBUG)
logging.basicConfig(format=LOGGING_FORMAT, level=log_level)
def copyfileobj_pad_truncate(src, dst, length=None):
"""
Copy length bytes from fileobj src to fileobj dst.
If length is None, copy the entire content.
This method is used by the TarFileIgnoringTruncate.addfile().
"""
if length == 0:
return
if length is None:
shutil.copyfileobj(src, dst, BUFSIZE)
return
blocks, remainder = divmod(length, BUFSIZE)
for _ in range(blocks):
buf = src.read(BUFSIZE)
dst.write(buf)
if len(buf) < BUFSIZE:
# End of file reached
# The file must have been truncated, so pad with zeroes
dst.write(tarfile.NUL * (BUFSIZE - len(buf)))
if remainder != 0:
buf = src.read(remainder)
dst.write(buf)
if len(buf) < remainder:
# End of file reached
# The file must have been truncated, so pad with zeroes
dst.write(tarfile.NUL * (remainder - len(buf)))
class CloudProviderError(BarmanException):
"""
This exception is raised when we get an error in the response from the
cloud provider
"""
class CloudUploadingError(BarmanException):
"""
This exception is raised when there are upload errors
"""
class TarFileIgnoringTruncate(tarfile.TarFile):
"""
Custom TarFile class that ignore truncated or vanished files.
"""
format = tarfile.PAX_FORMAT # Use PAX format to better preserve metadata
def addfile(self, tarinfo, fileobj=None):
"""
Add the provided fileobj to the tar ignoring truncated or vanished
files.
This method completely replaces TarFile.addfile()
"""
self._check("awx")
tarinfo = copy.copy(tarinfo)
buf = tarinfo.tobuf(self.format, self.encoding, self.errors)
self.fileobj.write(buf)
self.offset += len(buf)
# If there's data to follow, append it.
if fileobj is not None:
copyfileobj_pad_truncate(fileobj, self.fileobj, tarinfo.size)
blocks, remainder = divmod(tarinfo.size, tarfile.BLOCKSIZE)
if remainder > 0:
self.fileobj.write(tarfile.NUL * (tarfile.BLOCKSIZE - remainder))
blocks += 1
self.offset += blocks * tarfile.BLOCKSIZE
self.members.append(tarinfo)
class CloudTarUploader(object):
# This is the method we use to create new buffers
# We use named temporary files, so we can pass them by name to
# other processes
_buffer = partial(
NamedTemporaryFile, delete=False, prefix="barman-upload-", suffix=".part"
)
def __init__(self, cloud_interface, key, compression=None, chunk_size=None):
"""
A tar archive that resides on cloud storage
:param CloudInterface cloud_interface: cloud interface instance
:param str key: path inside the bucket
:param str compression: required compression
:param int chunk_size: the upload chunk size
"""
self.cloud_interface = cloud_interface
self.key = key
self.upload_metadata = None
if chunk_size is None:
self.chunk_size = cloud_interface.MIN_CHUNK_SIZE
else:
self.chunk_size = max(chunk_size, cloud_interface.MIN_CHUNK_SIZE)
self.buffer = None
self.counter = 0
self.compressor = None
# Some supported compressions (e.g. snappy) require CloudTarUploader to apply
# compression manually rather than relying on the tar file.
self.compressor = cloud_compression.get_compressor(compression)
# If the compression is supported by tar then it will be added to the filemode
# passed to tar_mode.
tar_mode = cloud_compression.get_streaming_tar_mode("w", compression)
# The value of 65536 for the chunk size is based on comments in the python-snappy
# library which suggest it should be good for almost every scenario.
# See: https://github.com/andrix/python-snappy/blob/0.6.0/snappy/snappy.py#L282
self.tar = TarFileIgnoringTruncate.open(
fileobj=self, mode=tar_mode, bufsize=64 << 10
)
self.size = 0
self.stats = None
def write(self, buf):
if self.buffer and self.buffer.tell() > self.chunk_size:
self.flush()
if not self.buffer:
self.buffer = self._buffer()
if self.compressor:
# If we have a custom compressor we must use it here
compressed_buf = self.compressor.add_chunk(buf)
self.buffer.write(compressed_buf)
self.size += len(compressed_buf)
else:
# If there is no custom compressor then we are either not using
# compression or tar has already compressed it - in either case we
# just write the data to the buffer
self.buffer.write(buf)
self.size += len(buf)
def flush(self):
if not self.upload_metadata:
self.upload_metadata = self.cloud_interface.create_multipart_upload(
self.key
)
self.buffer.flush()
self.buffer.seek(0, os.SEEK_SET)
self.counter += 1
self.cloud_interface.async_upload_part(
upload_metadata=self.upload_metadata,
key=self.key,
body=self.buffer,
part_number=self.counter,
)
self.buffer.close()
self.buffer = None
def close(self):
if self.tar:
self.tar.close()
self.flush()
self.cloud_interface.async_complete_multipart_upload(
upload_metadata=self.upload_metadata,
key=self.key,
parts_count=self.counter,
)
self.stats = self.cloud_interface.wait_for_multipart_upload(self.key)
class CloudUploadController(object):
def __init__(self, cloud_interface, key_prefix, max_archive_size, compression):
"""
Create a new controller that upload the backup in cloud storage
:param CloudInterface cloud_interface: cloud interface instance
:param str|None key_prefix: path inside the bucket
:param int max_archive_size: the maximum size of an archive
:param str|None compression: required compression
"""
self.cloud_interface = cloud_interface
if key_prefix and key_prefix[0] == "/":
key_prefix = key_prefix[1:]
self.key_prefix = key_prefix
if max_archive_size < self.cloud_interface.MAX_ARCHIVE_SIZE:
self.max_archive_size = max_archive_size
else:
logging.warning(
"max-archive-size too big. Capping it to to %s",
pretty_size(self.cloud_interface.MAX_ARCHIVE_SIZE),
)
self.max_archive_size = self.cloud_interface.MAX_ARCHIVE_SIZE
# We aim to a maximum of MAX_CHUNKS_PER_FILE / 2 chinks per file
self.chunk_size = 2 * int(
max_archive_size / self.cloud_interface.MAX_CHUNKS_PER_FILE
)
self.compression = compression
self.tar_list = {}
self.upload_stats = {}
"""Already finished uploads list"""
self.copy_start_time = datetime.datetime.now()
"""Copy start time"""
self.copy_end_time = None
"""Copy end time"""
def _build_dest_name(self, name, count=0):
"""
Get the destination tar name
:param str name: the name prefix
:param int count: the part count
:rtype: str
"""
components = [name]
if count > 0:
components.append("_%04d" % count)
components.append(".tar")
if self.compression == "gz":
components.append(".gz")
elif self.compression == "bz2":
components.append(".bz2")
elif self.compression == "snappy":
components.append(".snappy")
return "".join(components)
def _get_tar(self, name):
"""
Get a named tar file from cloud storage.
Subsequent call with the same name return the same name
:param str name: tar name
:rtype: tarfile.TarFile
"""
if name not in self.tar_list or not self.tar_list[name]:
self.tar_list[name] = [
CloudTarUploader(
cloud_interface=self.cloud_interface,
key=os.path.join(self.key_prefix, self._build_dest_name(name)),
compression=self.compression,
chunk_size=self.chunk_size,
)
]
# If the current uploading file size is over DEFAULT_MAX_TAR_SIZE
# Close the current file and open the next part
uploader = self.tar_list[name][-1]
if uploader.size > self.max_archive_size:
uploader.close()
uploader = CloudTarUploader(
cloud_interface=self.cloud_interface,
key=os.path.join(
self.key_prefix,
self._build_dest_name(name, len(self.tar_list[name])),
),
compression=self.compression,
chunk_size=self.chunk_size,
)
self.tar_list[name].append(uploader)
return uploader.tar
def upload_directory(self, label, src, dst, exclude=None, include=None):
logging.info(
"Uploading '%s' directory '%s' as '%s'",
label,
src,
self._build_dest_name(dst),
)
for root, dirs, files in os.walk(src):
tar_root = os.path.relpath(root, src)
if not path_allowed(exclude, include, tar_root, True):
continue
try:
self._get_tar(dst).add(root, arcname=tar_root, recursive=False)
except EnvironmentError as e:
if e.errno == errno.ENOENT:
# If a directory disappeared just skip it,
# WAL reply will take care during recovery.
continue
else:
raise
for item in files:
tar_item = os.path.join(tar_root, item)
if not path_allowed(exclude, include, tar_item, False):
continue
logging.debug("Uploading %s", tar_item)
try:
self._get_tar(dst).add(os.path.join(root, item), arcname=tar_item)
except EnvironmentError as e:
if e.errno == errno.ENOENT:
# If a file disappeared just skip it,
# WAL reply will take care during recovery.
continue
else:
raise
def add_file(self, label, src, dst, path, optional=False):
if optional and not os.path.exists(src):
return
logging.info(
"Uploading '%s' file from '%s' to '%s' with path '%s'",
label,
src,
self._build_dest_name(dst),
path,
)
tar = self._get_tar(dst)
tar.add(src, arcname=path)
def add_fileobj(self, label, fileobj, dst, path, mode=None, uid=None, gid=None):
logging.info(
"Uploading '%s' file to '%s' with path '%s'",
label,
self._build_dest_name(dst),
path,
)
tar = self._get_tar(dst)
tarinfo = tar.tarinfo(path)
fileobj.seek(0, os.SEEK_END)
tarinfo.size = fileobj.tell()
if mode is not None:
tarinfo.mode = mode
if uid is not None:
tarinfo.gid = uid
if gid is not None:
tarinfo.gid = gid
fileobj.seek(0, os.SEEK_SET)
tar.addfile(tarinfo, fileobj)
def close(self):
logging.info("Marking all the uploaded archives as 'completed'")
for name in self.tar_list:
if self.tar_list[name]:
# Tho only opened file is the last one, all the others
# have been already closed
self.tar_list[name][-1].close()
self.upload_stats[name] = [tar.stats for tar in self.tar_list[name]]
self.tar_list[name] = None
# Store the end time
self.copy_end_time = datetime.datetime.now()
def statistics(self):
"""
Return statistics about the CloudUploadController object.
:rtype: dict
"""
logging.info("Calculating backup statistics")
# This method can only run at the end of a non empty copy
assert self.copy_end_time
assert self.upload_stats
# Initialise the result calculating the total runtime
stat = {
"total_time": total_seconds(self.copy_end_time - self.copy_start_time),
"number_of_workers": self.cloud_interface.worker_processes_count,
# Cloud uploads have no analysis
"analysis_time": 0,
"analysis_time_per_item": {},
"copy_time_per_item": {},
"serialized_copy_time_per_item": {},
}
# Calculate the time spent uploading
upload_start = None
upload_end = None
serialized_time = datetime.timedelta(0)
for name in self.upload_stats:
name_start = None
name_end = None
total_time = datetime.timedelta(0)
for index, data in enumerate(self.upload_stats[name]):
logging.debug(
"Calculating statistics for file %s, index %s, data: %s",
name,
index,
json.dumps(data, indent=2, sort_keys=True, cls=BarmanEncoder),
)
if upload_start is None or upload_start > data["start_time"]:
upload_start = data["start_time"]
if upload_end is None or upload_end < data["end_time"]:
upload_end = data["end_time"]
if name_start is None or name_start > data["start_time"]:
name_start = data["start_time"]
if name_end is None or name_end < data["end_time"]:
name_end = data["end_time"]
parts = data["parts"]
for num in parts:
part = parts[num]
total_time += part["end_time"] - part["start_time"]
stat["serialized_copy_time_per_item"][name] = total_seconds(total_time)
serialized_time += total_time
# Cloud uploads have no analysis
stat["analysis_time_per_item"][name] = 0
stat["copy_time_per_item"][name] = total_seconds(name_end - name_start)
# Store the total time spent by copying
stat["copy_time"] = total_seconds(upload_end - upload_start)
stat["serialized_copy_time"] = total_seconds(serialized_time)
return stat
class FileUploadStatistics(dict):
def __init__(self, *args, **kwargs):
super(FileUploadStatistics, self).__init__(*args, **kwargs)
start_time = datetime.datetime.now()
self.setdefault("status", "uploading")
self.setdefault("start_time", start_time)
self.setdefault("parts", {})
def set_part_end_time(self, part_number, end_time):
part = self["parts"].setdefault(part_number, {"part_number": part_number})
part["end_time"] = end_time
def set_part_start_time(self, part_number, start_time):
part = self["parts"].setdefault(part_number, {"part_number": part_number})
part["start_time"] = start_time
class DecompressingStreamingIO(RawIOBase):
"""
Provide an IOBase interface which decompresses streaming cloud responses.
This is intended to wrap azure_blob_storage.StreamingBlobIO and
aws_s3.StreamingBodyIO objects, transparently decompressing chunks while
continuing to expose them via the read method of the IOBase interface.
This allows TarFile to stream the uncompressed data directly from the cloud
provider responses without requiring it to know anything about the compression.
"""
# The value of 65536 for the chunk size is based on comments in the python-snappy
# library which suggest it should be good for almost every scenario.
# See: https://github.com/andrix/python-snappy/blob/0.6.0/snappy/snappy.py#L300
COMPRESSED_CHUNK_SIZE = 65536
def __init__(self, streaming_response, decompressor):
"""
Create a new DecompressingStreamingIO object.
A DecompressingStreamingIO object will be created which reads compressed
bytes from streaming_response and decompresses them with the supplied
decompressor.
:param RawIOBase streaming_response: A file-like object which provides the
data in the response streamed from the cloud provider.
:param barman.clients.cloud_compression.ChunkedCompressor: A ChunkedCompressor
object which provides a decompress(bytes) method to return the decompressed bytes.
"""
self.streaming_response = streaming_response
self.decompressor = decompressor
self.buffer = bytes()
def _read_from_uncompressed_buffer(self, n):
"""
Read up to n bytes from the local buffer of uncompressed data.
Removes up to n bytes from the local buffer and returns them. If n is
greater than the length of the buffer then the entire buffer content is
returned and the buffer is emptied.
:param int n: The number of bytes to read
:return: The bytes read from the local buffer
:rtype: bytes
"""
if n <= len(self.buffer):
return_bytes = self.buffer[:n]
self.buffer = self.buffer[n:]
return return_bytes
else:
return_bytes = self.buffer
self.buffer = bytes()
return return_bytes
def read(self, n=-1):
"""
Read up to n bytes of uncompressed data from the wrapped IOBase.
Bytes are initially read from the local buffer of uncompressed data. If more
bytes are required then chunks of COMPRESSED_CHUNK_SIZE are read from the
wrapped IOBase and decompressed in memory until >= n uncompressed bytes have
been read. n bytes are then returned with any remaining bytes being stored
in the local buffer for future requests.
:param int n: The number of uncompressed bytes required
:return: Up to n uncompressed bytes from the wrapped IOBase
:rtype: bytes
"""
uncompressed_bytes = self._read_from_uncompressed_buffer(n)
if len(uncompressed_bytes) == n:
return uncompressed_bytes
while len(uncompressed_bytes) < n:
compressed_bytes = self.streaming_response.read(self.COMPRESSED_CHUNK_SIZE)
uncompressed_bytes += self.decompressor.decompress(compressed_bytes)
if len(compressed_bytes) < self.COMPRESSED_CHUNK_SIZE:
# If we got fewer bytes than we asked for then we're done
break
return_bytes = uncompressed_bytes[:n]
self.buffer = uncompressed_bytes[n:]
return return_bytes
class CloudInterface(with_metaclass(ABCMeta)):
"""
Abstract base class which provides the interface between barman and cloud
storage providers.
Support for individual cloud providers should be implemented by inheriting
from this class and providing implementations for the abstract methods.
This class provides generic boilerplate for the asynchronous and parallel
upload of objects to cloud providers which support multipart uploads.
These uploads are carried out by worker processes which are spawned by
_ensure_async and consume upload jobs from a queue. The public
async_upload_part and async_complete_multipart_upload methods add jobs
to this queue. When the worker processes consume the jobs they execute
the synchronous counterparts to the async_* methods (_upload_part and
_complete_multipart_upload) which must be implemented in CloudInterface
sub-classes.
Additional boilerplate for creating buckets and streaming objects as tar
files is also provided.
"""
@abstractproperty
def MAX_CHUNKS_PER_FILE(self):
"""
Maximum number of chunks allowed in a single file in cloud storage.
The exact definition of chunk depends on the cloud provider, for example
in AWS S3 a chunk would be one part in a multipart upload. In Azure a
chunk would be a single block of a block blob.
:type: int
"""
pass
@abstractproperty
def MIN_CHUNK_SIZE(self):
"""
Minimum size in bytes of a single chunk.
:type: int
"""
pass
@abstractproperty
def MAX_ARCHIVE_SIZE(self):
"""
Maximum size in bytes of a single file in cloud storage.
:type: int
"""
pass
def __init__(self, url, jobs=2, tags=None):
"""
Base constructor
:param str url: url for the cloud storage resource
:param int jobs: How many sub-processes to use for asynchronous
uploading, defaults to 2.
:param List[tuple] tags: List of tags as k,v tuples to be added to all
uploaded objects
"""
self.url = url
self.tags = tags
# The worker process and the shared queue are created only when
# needed
self.queue = None
self.result_queue = None
self.errors_queue = None
self.done_queue = None
self.error = None
self.abort_requested = False
self.worker_processes_count = jobs
self.worker_processes = []
# The parts DB is a dictionary mapping each bucket key name to a list
# of uploaded parts.
# This structure is updated by the _refresh_parts_db method call
self.parts_db = collections.defaultdict(list)
# Statistics about uploads
self.upload_stats = collections.defaultdict(FileUploadStatistics)
def close(self):
"""
Wait for all the asynchronous operations to be done
"""
if self.queue:
for _ in self.worker_processes:
self.queue.put(None)
for process in self.worker_processes:
process.join()
def _abort(self):
"""
Abort all the operations
"""
if self.queue:
for process in self.worker_processes:
os.kill(process.pid, signal.SIGINT)
self.close()
def _ensure_async(self):
"""
Ensure that the asynchronous execution infrastructure is up
and the worker process is running
"""
if self.queue:
return
self.queue = multiprocessing.JoinableQueue(maxsize=self.worker_processes_count)
self.result_queue = multiprocessing.Queue()
self.errors_queue = multiprocessing.Queue()
self.done_queue = multiprocessing.Queue()
# Delay assigning the worker_processes list to the object until we have
# finished spawning the workers so they do not get pickled by multiprocessing
# (pickling the worker process references will fail in Python >= 3.8)
worker_processes = []
for process_number in range(self.worker_processes_count):
process = multiprocessing.Process(
target=self._worker_process_main, args=(process_number,)
)
process.start()
worker_processes.append(process)
self.worker_processes = worker_processes
def _retrieve_results(self):
"""
Receive the results from workers and update the local parts DB,
making sure that each part list is sorted by part number
"""
# Wait for all the current jobs to be completed
self.queue.join()
touched_keys = []
while not self.result_queue.empty():
result = self.result_queue.get()
touched_keys.append(result["key"])
self.parts_db[result["key"]].append(result["part"])
# Save the upload end time of the part
stats = self.upload_stats[result["key"]]
stats.set_part_end_time(result["part_number"], result["end_time"])
for key in touched_keys:
self.parts_db[key] = sorted(
self.parts_db[key], key=operator.itemgetter("PartNumber")
)
# Read the results of completed uploads
while not self.done_queue.empty():
result = self.done_queue.get()
self.upload_stats[result["key"]].update(result)
# Raise an error if a job failed
self._handle_async_errors()
def _handle_async_errors(self):
"""
If an upload error has been discovered, stop the upload
process, stop all the workers and raise an exception
:return:
"""
# If an error has already been reported, do nothing
if self.error:
return
try:
self.error = self.errors_queue.get_nowait()
except EmptyQueue:
return
logging.error("Error received from upload worker: %s", self.error)
self._abort()
raise CloudUploadingError(self.error)
def _worker_process_main(self, process_number):
"""
Repeatedly grab a task from the queue and execute it, until a task
containing "None" is grabbed, indicating that the process must stop.
:param int process_number: the process number, used in the logging
output
"""
logging.info("Upload process started (worker %s)", process_number)
# We create a new session instead of reusing the one
# from the parent process to avoid any race condition
self._reinit_session()
while True:
task = self.queue.get()
if not task:
self.queue.task_done()
break
try:
self._worker_process_execute_job(task, process_number)
except Exception as exc:
logging.error(
"Upload error: %s (worker %s)", force_str(exc), process_number
)
logging.debug("Exception details:", exc_info=exc)
self.errors_queue.put(force_str(exc))
except KeyboardInterrupt:
if not self.abort_requested:
logging.info(
"Got abort request: upload cancelled (worker %s)",
process_number,
)
self.abort_requested = True
finally:
self.queue.task_done()
logging.info("Upload process stopped (worker %s)", process_number)
def _worker_process_execute_job(self, task, process_number):
"""
Exec a single task
:param Dict task: task to execute
:param int process_number: the process number, used in the logging
output
:return:
"""
if task["job_type"] == "upload_part":
if self.abort_requested:
logging.info(
"Skipping '%s', part '%s' (worker %s)"
% (task["key"], task["part_number"], process_number)
)
os.unlink(task["body"])
return
else:
logging.info(
"Uploading '%s', part '%s' (worker %s)"
% (task["key"], task["part_number"], process_number)
)
with open(task["body"], "rb") as fp:
part = self._upload_part(
task["upload_metadata"], task["key"], fp, task["part_number"]
)
os.unlink(task["body"])
self.result_queue.put(
{
"key": task["key"],
"part_number": task["part_number"],
"end_time": datetime.datetime.now(),
"part": part,
}
)
elif task["job_type"] == "complete_multipart_upload":
if self.abort_requested:
logging.info("Aborting %s (worker %s)" % (task["key"], process_number))
self._abort_multipart_upload(task["upload_metadata"], task["key"])
self.done_queue.put(
{
"key": task["key"],
"end_time": datetime.datetime.now(),
"status": "aborted",
}
)
else:
logging.info(
"Completing '%s' (worker %s)" % (task["key"], process_number)
)
self._complete_multipart_upload(
task["upload_metadata"], task["key"], task["parts_metadata"]
)
self.done_queue.put(
{
"key": task["key"],
"end_time": datetime.datetime.now(),
"status": "done",
}
)
else:
raise ValueError("Unknown task: %s", repr(task))
def async_upload_part(self, upload_metadata, key, body, part_number):
"""
Asynchronously upload a part into a multipart upload
:param dict upload_metadata: Provider-specific metadata for this upload
e.g. the multipart upload handle in AWS S3
:param str key: The key to use in the cloud service
:param any body: A stream-like object to upload
:param int part_number: Part number, starting from 1
"""
# If an error has already been reported, do nothing
if self.error:
return
self._ensure_async()
self._handle_async_errors()
# Save the upload start time of the part
stats = self.upload_stats[key]
stats.set_part_start_time(part_number, datetime.datetime.now())
# If the body is a named temporary file use it directly
# WARNING: this imply that the file will be deleted after the upload
if hasattr(body, "name") and hasattr(body, "delete") and not body.delete:
fp = body
else:
# Write a temporary file with the part contents
with NamedTemporaryFile(delete=False) as fp:
shutil.copyfileobj(body, fp, BUFSIZE)
# Pass the job to the uploader process
self.queue.put(
{
"job_type": "upload_part",
"upload_metadata": upload_metadata,
"key": key,
"body": fp.name,
"part_number": part_number,
}
)
def async_complete_multipart_upload(self, upload_metadata, key, parts_count):
"""
Asynchronously finish a certain multipart upload. This method grant
that the final call to the cloud storage will happen after all the
already scheduled parts have been uploaded.
:param dict upload_metadata: Provider-specific metadata for this upload
e.g. the multipart upload handle in AWS S3
:param str key: The key to use in the cloud service
:param int parts_count: Number of parts
"""
# If an error has already been reported, do nothing
if self.error:
return
self._ensure_async()
self._handle_async_errors()
# If parts_db has less then expected parts for this upload,
# wait for the workers to send the missing metadata
while len(self.parts_db[key]) < parts_count:
# Wait for all the current jobs to be completed and
# receive all available updates on worker status
self._retrieve_results()
# Finish the job in the uploader process
self.queue.put(
{
"job_type": "complete_multipart_upload",
"upload_metadata": upload_metadata,
"key": key,
"parts_metadata": self.parts_db[key],
}
)
del self.parts_db[key]
def wait_for_multipart_upload(self, key):
"""
Wait for a multipart upload to be completed and return the result
:param str key: The key to use in the cloud service
"""
# The upload must exist
assert key in self.upload_stats
# async_complete_multipart_upload must have been called
assert key not in self.parts_db
# If status is still uploading the upload has not finished yet
while self.upload_stats[key]["status"] == "uploading":
# Wait for all the current jobs to be completed and
# receive all available updates on worker status
self._retrieve_results()
return self.upload_stats[key]
def setup_bucket(self):
"""
Search for the target bucket. Create it if not exists
"""
if self.bucket_exists is None:
self.bucket_exists = self._check_bucket_existence()
# Create the bucket if it doesn't exist
if not self.bucket_exists:
self._create_bucket()
self.bucket_exists = True
def extract_tar(self, key, dst):
"""
Extract a tar archive from cloud to the local directory
:param str key: The key identifying the tar archive
:param str dst: Path of the directory into which the tar archive should
be extracted
"""
extension = os.path.splitext(key)[-1]
compression = "" if extension == ".tar" else extension[1:]
tar_mode = cloud_compression.get_streaming_tar_mode("r", compression)
fileobj = self.remote_open(key, cloud_compression.get_compressor(compression))
with tarfile.open(fileobj=fileobj, mode=tar_mode) as tf:
tf.extractall(path=dst)
@abstractmethod
def _reinit_session(self):
"""
Reinitialises any resources used to maintain a session with a cloud
provider. This is called by child processes in order to avoid any
potential race conditions around re-using the same session as the
parent process.
"""
@abstractmethod
def test_connectivity(self):
"""
Test that the cloud provider is reachable
:return: True if the cloud provider is reachable, False otherwise
:rtype: bool
"""
@abstractmethod
def _check_bucket_existence(self):
"""
Check cloud storage for the target bucket
:return: True if the bucket exists, False otherwise
:rtype: bool
"""
@abstractmethod
def _create_bucket(self):
"""
Create the bucket in cloud storage
"""
@abstractmethod
def list_bucket(self, prefix="", delimiter="/"):
"""
List bucket content in a directory manner
:param str prefix:
:param str delimiter:
:return: List of objects and dirs right under the prefix
:rtype: List[str]
"""
@abstractmethod
def download_file(self, key, dest_path, decompress):
"""
Download a file from cloud storage
:param str key: The key identifying the file to download
:param str dest_path: Where to put the destination file
:param bool decompress: Whenever to decompress this file or not
"""
@abstractmethod
def remote_open(self, key, decompressor=None):
"""
Open a remote object in cloud storage and returns a readable stream
:param str key: The key identifying the object to open
:param barman.clients.cloud_compression.ChunkedCompressor decompressor:
A ChunkedCompressor object which will be used to decompress chunks of bytes
as they are read from the stream
:return: A file-like object from which the stream can be read or None if
the key does not exist
"""
@abstractmethod
def upload_fileobj(self, fileobj, key, override_tags=None):
"""
Synchronously upload the content of a file-like object to a cloud key
:param fileobj IOBase: File-like object to upload
:param str key: The key to identify the uploaded object
:param List[tuple] override_tags: List of k,v tuples which should override any
tags already defined in the cloud interface
"""
@abstractmethod
def create_multipart_upload(self, key):
"""
Create a new multipart upload and return any metadata returned by the
cloud provider.
This metadata is treated as an opaque blob by CloudInterface and will
be passed into the _upload_part, _complete_multipart_upload and
_abort_multipart_upload methods.
The implementations of these methods will need to handle this metadata in
the way expected by the cloud provider.
Some cloud services do not require multipart uploads to be explicitly
created. In such cases the implementation can be a no-op which just
returns None.
:param key: The key to use in the cloud service
:return: The multipart upload metadata
:rtype: dict[str, str]|None
"""
@abstractmethod
def _upload_part(self, upload_metadata, key, body, part_number):
"""
Upload a part into this multipart upload and return a dict of part
metadata. The part metadata must contain the key "PartNumber" and can
optionally contain any other metadata available (for example the ETag
returned by S3).
The part metadata will included in a list of metadata for all parts of
the upload which is passed to the _complete_multipart_upload method.
:param dict upload_metadata: Provider-specific metadata for this upload
e.g. the multipart upload handle in AWS S3
:param str key: The key to use in the cloud service
:param object body: A stream-like object to upload
:param int part_number: Part number, starting from 1
:return: The part metadata
:rtype: dict[str, None|str]
"""
@abstractmethod
def _complete_multipart_upload(self, upload_metadata, key, parts_metadata):
"""
Finish a certain multipart upload
:param dict upload_metadata: Provider-specific metadata for this upload
e.g. the multipart upload handle in AWS S3
:param str key: The key to use in the cloud service
:param List[dict] parts_metadata: The list of metadata for the parts
composing the multipart upload. Each part is guaranteed to provide a
PartNumber and may optionally contain additional metadata returned by
the cloud provider such as ETags.
"""
@abstractmethod
def _abort_multipart_upload(self, upload_metadata, key):
"""
Abort a certain multipart upload
The implementation of this method should clean up any dangling resources
left by the incomplete upload.
:param dict upload_metadata: Provider-specific metadata for this upload
e.g. the multipart upload handle in AWS S3
:param str key: The key to use in the cloud service
"""
@abstractmethod
def delete_objects(self, paths):
"""
Delete the objects at the specified paths
:param List[str] paths:
"""
class CloudBackupUploader(with_metaclass(ABCMeta)):
"""
Abstract base class which provides a client for uploading backups.
This should be inherited from by specialised classes which have knowledge
of the specific backup scenario. Initially two scenarios are implemented:
* Upload of a backup on a live PostgreSQL server.
* Upload of an existing backup on a Barman server.
Code for uploading tablespaces and pgdata files is provided in _backup_copy.
This will work for data located on a live PostgreSQL server or an existing
backup on a Barman server.
"""
def __init__(
self,
server_name,
cloud_interface,
max_archive_size,
compression=None,
):
"""
Base constructor.
:param str server_name: The name of the server as configured in Barman
:param CloudInterface cloud_interface: The interface to use to
upload the backup
:param int max_archive_size: the maximum size of an uploading archive
:param str compression: Compression algorithm to use
"""
self.compression = compression
self.server_name = server_name
self.cloud_interface = cloud_interface
self.max_archive_size = max_archive_size
# Stats
self.copy_start_time = None
self.copy_end_time = None
def _create_upload_controller(self, backup_id):
"""
Create an upload controller from the specified backup_id
:param str backup_id: The backup identifier
:return: The upload controller
:rtype: CloudUploadController
"""
key_prefix = os.path.join(
self.cloud_interface.path,
self.server_name,
"base",
backup_id,
)
return CloudUploadController(
self.cloud_interface,
key_prefix,
self.max_archive_size,
self.compression,
)
@abstractmethod
def _get_tablespace_location(self, tablespace):
"""
Return the on-disk location of the supplied tablespace
This will vary depending on whether barman-cloud is running on a live
PostgreSQL server or a Barman server
"""
def _backup_copy(self, controller, backup_info, pgdata_dir, server_major_version):
"""
Perform the actual copy of the backup uploading it to cloud storage.
First, it copies one tablespace at a time, then the PGDATA directory,
then pg_control.
Bandwidth limitation, according to configuration, is applied in
the process.
:param barman.cloud.CloudUploadController controller: upload controller
:param barman.infofile.BackupInfo backup_info: backup information
:param str pgdata_dir: Path to pgdata directory
:param str server_major_version: Major version of the postgres server
being backed up
"""
# Store the start time
self.copy_start_time = datetime.datetime.now()
# List of paths to be excluded by the PGDATA copy
exclude = []
# Process every tablespace
if backup_info.tablespaces:
for tablespace in backup_info.tablespaces:
# If the tablespace location is inside the data directory,
# exclude and protect it from being copied twice during
# the data directory copy
if tablespace.location.startswith(backup_info.pgdata + "/"):
exclude += [tablespace.location[len(backup_info.pgdata) :]]
# Exclude and protect the tablespace from being copied again
# during the data directory copy
exclude += ["/pg_tblspc/%s" % tablespace.oid]
# Copy the tablespace directory.
# NOTE: Barman should archive only the content of directory
# "PG_" + PG_MAJORVERSION + "_" + CATALOG_VERSION_NO
# but CATALOG_VERSION_NO is not easy to retrieve, so we copy
# "PG_" + PG_MAJORVERSION + "_*"
# It could select some spurious directory if a development or
# a beta version have been used, but it's good enough for a
# production system as it filters out other major versions.
controller.upload_directory(
label=tablespace.name,
src=self._get_tablespace_location(tablespace),
dst="%s" % tablespace.oid,
exclude=["/*"] + EXCLUDE_LIST,
include=["/PG_%s_*" % server_major_version],
)
# Copy PGDATA directory (or if that is itself a symlink, just follow it
# and copy whatever it points to; we won't store the symlink in the tar
# file)
if os.path.islink(pgdata_dir):
pgdata_dir = os.path.realpath(pgdata_dir)
controller.upload_directory(
label="pgdata",
src=pgdata_dir,
dst="data",
exclude=PGDATA_EXCLUDE_LIST + EXCLUDE_LIST + exclude,
)
# At last copy pg_control
controller.add_file(
label="pg_control",
src="%s/global/pg_control" % pgdata_dir,
dst="data",
path="global/pg_control",
)
@abstractmethod
def backup(self):
"""
Coordinate the upload of a Backup to cloud storage
Any necessary coordination, such as calling pg_start_backup in PostgreSQL,
should happen here.
"""
@abstractmethod
def handle_backup_errors(self, action, exc):
"""
Perform appropriate cleanup actions and exit
:param str action: the upload phase that has failed
:param BaseException exc: the exception that caused the failure
"""
class CloudBackupUploaderBarman(CloudBackupUploader):
"""
A cloud storage upload client for a pre-existing backup on the Barman server.
"""
def __init__(
self,
server_name,
cloud_interface,
max_archive_size,
backup_dir,
backup_id,
compression=None,
):
"""
Create the cloud storage upload client for a backup in the specified
location with the specified backup_id.
:param str server_name: The name of the server as configured in Barman
:param CloudInterface cloud_interface: The interface to use to
upload the backup
:param int max_archive_size: the maximum size of an uploading archive
:param str backup_dir: Path to the directory containing the backup to
be uploaded
:param str backup_id: The id of the backup to upload
:param str compression: Compression algorithm to use
"""
super(CloudBackupUploaderBarman, self).__init__(
server_name,
cloud_interface,
max_archive_size,
compression=compression,
)
self.backup_dir = backup_dir
self.backup_id = backup_id
def _get_tablespace_location(self, tablespace):
"""
Determines the tablespace location by combining the backup directory with
the oid of the tablespace.
"""
return os.path.join(self.backup_dir, str(tablespace.oid))
def backup(self):
"""
Upload a Backup to cloud storage
"""
# Read the backup_info file from disk as the backup has already been created
backup_info = BackupInfo(self.backup_id)
backup_info.load(filename=os.path.join(self.backup_dir, "backup.info"))
controller = self._create_upload_controller(self.backup_id)
try:
self._backup_copy(
controller,
backup_info,
os.path.join(self.backup_dir, "data"),
backup_info.pg_major_version(),
)
# Closing the controller will finalize all the running uploads
controller.close()
# Store the end time
self.copy_end_time = datetime.datetime.now()
# Manually add backup.info
with open(
os.path.join(self.backup_dir, "backup.info"), "rb"
) as backup_info_file:
self.cloud_interface.upload_fileobj(
backup_info_file,
key=os.path.join(controller.key_prefix, "backup.info"),
)
# Use BaseException instead of Exception to catch events like
# KeyboardInterrupt (e.g.: CTRL-C)
except BaseException as exc:
# Mark the backup as failed and exit
self.handle_backup_errors("uploading data", exc)
raise SystemExit(1)
logging.info(
"Upload of backup completed (start time: %s, elapsed time: %s)",
self.copy_start_time,
human_readable_timedelta(datetime.datetime.now() - self.copy_start_time),
)
def handle_backup_errors(self, action, exc):
"""
Log that the backup upload has failed and exit
:param str action: the upload phase that has failed
:param BaseException exc: the exception that caused the failure
"""
msg_lines = force_str(exc).strip().splitlines()
# If the exception has no attached message use the raw
# type name
if len(msg_lines) == 0:
msg_lines = [type(exc).__name__]
logging.error("Backup upload failed %s (%s)", action, msg_lines[0])
logging.debug("Exception details:", exc_info=exc)
class CloudBackupUploaderPostgres(CloudBackupUploader):
"""
A cloud storage upload client for a live PostgreSQL server.
"""
def __init__(
self,
server_name,
cloud_interface,
max_archive_size,
postgres,
compression=None,
):
super(CloudBackupUploaderPostgres, self).__init__(
server_name,
cloud_interface,
max_archive_size,
compression=compression,
)
self.postgres = postgres
def _get_tablespace_location(self, tablespace):
"""
Just returns the location of the tablespace as we are running on the
PostgreSQL server.
"""
return tablespace.location
def _backup_copy(self, controller, backup_info, pgdata_dir, server_major_version):
"""
Perform the actual copy of the backup uploading it to cloud storage.
The core implementation of _backup_copy is extended here so that we
include external config files on the PostgreSQL server.
"""
super(CloudBackupUploaderPostgres, self)._backup_copy(
controller, backup_info, pgdata_dir, server_major_version
)
# Copy configuration files (if not inside PGDATA)
external_config_files = backup_info.get_external_config_files()
included_config_files = []
for config_file in external_config_files:
# Add included files to a list, they will be handled later
if config_file.file_type == "include":
included_config_files.append(config_file)
continue
# If the ident file is missing, it isn't an error condition
# for PostgreSQL.
# Barman is consistent with this behavior.
optional = False
if config_file.file_type == "ident_file":
optional = True
# Create the actual copy jobs in the controller
controller.add_file(
label=config_file.file_type,
src=config_file.path,
dst="data",
path=os.path.basename(config_file.path),
optional=optional,
)
# Check for any include directives in PostgreSQL configuration
# Currently, include directives are not supported for files that
# reside outside PGDATA. These files must be manually backed up.
# Barman will emit a warning and list those files
if any(included_config_files):
msg = (
"The usage of include directives is not supported "
"for files that reside outside PGDATA.\n"
"Please manually backup the following files:\n"
"\t%s\n" % "\n\t".join(icf.path for icf in included_config_files)
)
logging.warning(msg)
def backup(self):
"""
Upload a Backup to cloud storage directly from a live PostgreSQL server.
"""
server_name = "cloud"
backup_info = BackupInfo(
backup_id=datetime.datetime.now().strftime("%Y%m%dT%H%M%S"),
server_name=server_name,
)
backup_info.set_attribute("systemid", self.postgres.get_systemid())
controller = self._create_upload_controller(backup_info.backup_id)
if self.postgres.server_version >= 90600 or self.postgres.has_pgespresso:
strategy = ConcurrentBackupStrategy(self.postgres, server_name)
else:
strategy = ExclusiveBackupStrategy(self.postgres, server_name)
logging.info("Starting backup '%s'", backup_info.backup_id)
strategy.start_backup(backup_info)
try:
self._backup_copy(
controller,
backup_info,
backup_info.pgdata,
self.postgres.server_major_version,
)
logging.info("Stopping backup '%s'", backup_info.backup_id)
strategy.stop_backup(backup_info)
# Create a restore point after a backup
target_name = "barman_%s" % backup_info.backup_id
self.postgres.create_restore_point(target_name)
# Free the Postgres connection
self.postgres.close()
# Eventually, add the backup_label from the backup_info
if backup_info.backup_label:
pgdata_stat = os.stat(backup_info.pgdata)
controller.add_fileobj(
label="backup_label",
fileobj=BytesIO(backup_info.backup_label.encode("UTF-8")),
dst="data",
path="backup_label",
uid=pgdata_stat.st_uid,
gid=pgdata_stat.st_gid,
)
# Closing the controller will finalize all the running uploads
controller.close()
# Store the end time
self.copy_end_time = datetime.datetime.now()
# Store statistics about the copy
backup_info.set_attribute("copy_stats", controller.statistics())
# Set the backup status as DONE
backup_info.set_attribute("status", BackupInfo.DONE)
# Use BaseException instead of Exception to catch events like
# KeyboardInterrupt (e.g.: CTRL-C)
except BaseException as exc:
# Mark the backup as failed and exit
self.handle_backup_errors("uploading data", exc, backup_info)
raise SystemExit(1)
finally:
try:
with BytesIO() as backup_info_file:
backup_info.save(file_object=backup_info_file)
backup_info_file.seek(0, os.SEEK_SET)
key = os.path.join(controller.key_prefix, "backup.info")
logging.info("Uploading '%s'", key)
self.cloud_interface.upload_fileobj(backup_info_file, key)
except BaseException as exc:
# Mark the backup as failed and exit
self.handle_backup_errors(
"uploading backup.info file", exc, backup_info
)
raise SystemExit(1)
logging.info(
"Backup end at LSN: %s (%s, %08X)",
backup_info.end_xlog,
backup_info.end_wal,
backup_info.end_offset,
)
logging.info(
"Backup completed (start time: %s, elapsed time: %s)",
self.copy_start_time,
human_readable_timedelta(datetime.datetime.now() - self.copy_start_time),
)
def handle_backup_errors(self, action, exc, backup_info):
"""
Mark the backup as failed and exit
:param str action: the upload phase that has failed
:param barman.infofile.BackupInfo backup_info: the backup info file
:param BaseException exc: the exception that caused the failure
"""
msg_lines = force_str(exc).strip().splitlines()
# If the exception has no attached message use the raw
# type name
if len(msg_lines) == 0:
msg_lines = [type(exc).__name__]
if backup_info:
# Use only the first line of exception message
# in backup_info error field
backup_info.set_attribute("status", BackupInfo.FAILED)
backup_info.set_attribute(
"error", "failure %s (%s)" % (action, msg_lines[0])
)
logging.error("Backup failed %s (%s)", action, msg_lines[0])
logging.debug("Exception details:", exc_info=exc)
class BackupFileInfo(object):
def __init__(self, oid=None, base=None, path=None, compression=None):
self.oid = oid
self.base = base
self.path = path
self.compression = compression
self.additional_files = []
class CloudBackupCatalog(KeepManagerMixinCloud):
"""
Cloud storage backup catalog
"""
def __init__(self, cloud_interface, server_name):
"""
Object responsible for retrievin backup catalog from cloud storage
:param CloudInterface cloud_interface: The interface to use to
upload the backup
:param str server_name: The name of the server as configured in Barman
"""
super(CloudBackupCatalog, self).__init__(
cloud_interface=cloud_interface, server_name=server_name
)
self.cloud_interface = cloud_interface
self.server_name = server_name
self.prefix = os.path.join(self.cloud_interface.path, self.server_name, "base")
self.wal_prefix = os.path.join(
self.cloud_interface.path, self.server_name, "wals"
)
self._backup_list = None
self._wal_paths = None
self.unreadable_backups = []
def get_backup_list(self):
"""
Retrieve the list of available backup from cloud storage
:rtype: Dict[str,BackupInfo]
"""
if self._backup_list is None:
backup_list = {}
# get backups metadata
for backup_dir in self.cloud_interface.list_bucket(self.prefix + "/"):
# We want only the directories
if backup_dir[-1] != "/":
continue
backup_id = os.path.basename(backup_dir.rstrip("/"))
try:
backup_info = self.get_backup_info(backup_id)
except Exception as exc:
logging.warning(
"Unable to open backup.info file for %s: %s" % (backup_id, exc)
)
self.unreadable_backups.append(backup_id)
continue
if backup_info:
backup_list[backup_id] = backup_info
self._backup_list = backup_list
return self._backup_list
def remove_backup_from_cache(self, backup_id):
"""
Remove backup with backup_id from the cached list. This is intended for
cases where we want to update the state without firing lots of requests
at the bucket.
"""
if self._backup_list:
self._backup_list.pop(backup_id)
def get_wal_paths(self):
"""
Retrieve a dict of WAL paths keyed by the WAL name from cloud storage
"""
if self._wal_paths is None:
wal_paths = {}
for wal in self.cloud_interface.list_bucket(
self.wal_prefix + "/", delimiter=""
):
wal_basename = os.path.basename(wal)
if xlog.is_any_xlog_file(wal_basename):
# We have an uncompressed xlog of some kind
wal_paths[wal_basename] = wal
else:
# Allow one suffix for compression and try again
wal_name, suffix = os.path.splitext(wal_basename)
if suffix in ALLOWED_COMPRESSIONS and xlog.is_any_xlog_file(
wal_name
):
wal_paths[wal_name] = wal
else:
# If it still doesn't look like an xlog file, ignore
continue
self._wal_paths = wal_paths
return self._wal_paths
def remove_wal_from_cache(self, wal_name):
"""
Remove named wal from the cached list. This is intended for cases where
we want to update the state without firing lots of requests at the bucket.
"""
if self._wal_paths:
self._wal_paths.pop(wal_name)
def get_backup_info(self, backup_id):
"""
Load a BackupInfo from cloud storage
:param str backup_id: The backup id to load
:rtype: BackupInfo
"""
backup_info_path = os.path.join(self.prefix, backup_id, "backup.info")
backup_info_file = self.cloud_interface.remote_open(backup_info_path)
if backup_info_file is None:
return None
backup_info = BackupInfo(backup_id)
backup_info.load(file_object=backup_info_file)
return backup_info
def get_backup_files(self, backup_info, allow_missing=False):
"""
Get the list of expected files part of a backup
:param BackupInfo backup_info: the backup information
:param bool allow_missing: True if missing backup files are allowed, False
otherwise. A value of False will cause a SystemExit to be raised if any
files expected due to the `backup_info` content cannot be found.
:rtype: dict[int, BackupFileInfo]
"""
# Correctly format the source path
source_dir = os.path.join(self.prefix, backup_info.backup_id)
base_path = os.path.join(source_dir, "data")
backup_files = {None: BackupFileInfo(None, base_path)}
if backup_info.tablespaces:
for tblspc in backup_info.tablespaces:
base_path = os.path.join(source_dir, "%s" % tblspc.oid)
backup_files[tblspc.oid] = BackupFileInfo(tblspc.oid, base_path)
for item in self.cloud_interface.list_bucket(source_dir + "/"):
for backup_file in backup_files.values():
if item.startswith(backup_file.base):
# Automatically detect additional files
suffix = item[len(backup_file.base) :]
# Avoid to match items that are prefix of other items
if not suffix or suffix[0] not in (".", "_"):
logging.debug(
"Skipping spurious prefix match: %s|%s",
backup_file.base,
suffix,
)
continue
# If this file have a suffix starting with `_`,
# it is an additional file and we add it to the main
# BackupFileInfo ...
if suffix[0] == "_":
info = BackupFileInfo(backup_file.oid, base_path)
backup_file.additional_files.append(info)
ext = suffix.split(".", 1)[-1]
# ... otherwise this is the main file
else:
info = backup_file
ext = suffix[1:]
# Infer the compression from the file extension
if ext == "tar":
info.compression = None
elif ext == "tar.gz":
info.compression = "gzip"
elif ext == "tar.bz2":
info.compression = "bzip2"
elif ext == "tar.snappy":
info.compression = "snappy"
else:
logging.warning("Skipping unknown extension: %s", ext)
continue
info.path = item
logging.info(
"Found file from backup '%s' of server '%s': %s",
backup_info.backup_id,
self.server_name,
info.path,
)
break
for backup_file in backup_files.values():
logging_fun = logging.warning if allow_missing else logging.error
if backup_file.path is None:
logging_fun(
"Missing file %s.* for server %s",
backup_file.base,
self.server_name,
)
if not allow_missing:
raise SystemExit(1)
return backup_files
barman-2.18/barman/infofile.py 0000644 0006212 0006212 00000064417 14172556763 014521 0 ustar 0000000 0000000 # -*- coding: utf-8 -*-
# © Copyright EnterpriseDB UK Limited 2013-2022
#
# This file is part of Barman.
#
# Barman is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Barman is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Barman. If not, see .
import ast
import collections
import inspect
import logging
import os
import dateutil.parser
import dateutil.tz
from barman import xlog
from barman.exceptions import BackupInfoBadInitialisation
from barman.utils import fsync_dir
# Named tuple representing a Tablespace with 'name' 'oid' and 'location'
# as property.
Tablespace = collections.namedtuple("Tablespace", "name oid location")
# Named tuple representing a file 'path' with an associated 'file_type'
TypedFile = collections.namedtuple("ConfFile", "file_type path")
_logger = logging.getLogger(__name__)
def output_tablespace_list(tablespaces):
"""
Return the literal representation of tablespaces as a Python string
:param tablespaces tablespaces: list of Tablespaces objects
:return str: Literal representation of tablespaces
"""
if tablespaces:
return repr([tuple(item) for item in tablespaces])
else:
return None
def load_tablespace_list(string):
"""
Load the tablespaces as a Python list of namedtuple
Uses ast to evaluate information about tablespaces.
The returned list is used to create a list of namedtuple
:param str string:
:return list: list of namedtuple representing all the tablespaces
"""
obj = ast.literal_eval(string)
if obj:
return [Tablespace._make(item) for item in obj]
else:
return None
def null_repr(obj):
"""
Return the literal representation of an object
:param object obj: object to represent
:return str|None: Literal representation of an object or None
"""
return repr(obj) if obj else None
def load_datetime_tz(time_str):
"""
Load datetime and ensure the result is timezone-aware.
If the parsed timestamp is naive, transform it into a timezone-aware one
using the local timezone.
:param str time_str: string representing a timestamp
:return datetime: the parsed timezone-aware datetime
"""
# dateutil parser returns naive or tz-aware string depending on the format
# of the input string
timestamp = dateutil.parser.parse(time_str)
# if the parsed timestamp is naive, forces it to local timezone
if timestamp.tzinfo is None:
timestamp = timestamp.replace(tzinfo=dateutil.tz.tzlocal())
return timestamp
class Field(object):
def __init__(self, name, dump=None, load=None, default=None, doc=None):
"""
Field descriptor to be used with a FieldListFile subclass.
The resulting field is like a normal attribute with
two optional associated function: to_str and from_str
The Field descriptor can also be used as a decorator
class C(FieldListFile):
x = Field('x')
@x.dump
def x(val): return '0x%x' % val
@x.load
def x(val): return int(val, 16)
:param str name: the name of this attribute
:param callable dump: function used to dump the content to a disk
:param callable load: function used to reload the content from disk
:param default: default value for the field
:param str doc: docstring of the filed
"""
self.name = name
self.to_str = dump
self.from_str = load
self.default = default
self.__doc__ = doc
# noinspection PyUnusedLocal
def __get__(self, obj, objtype=None):
if obj is None:
return self
if not hasattr(obj, "_fields"):
obj._fields = {}
return obj._fields.setdefault(self.name, self.default)
def __set__(self, obj, value):
if not hasattr(obj, "_fields"):
obj._fields = {}
obj._fields[self.name] = value
def __delete__(self, obj):
raise AttributeError("can't delete attribute")
def dump(self, to_str):
return type(self)(self.name, to_str, self.from_str, self.__doc__)
def load(self, from_str):
return type(self)(self.name, self.to_str, from_str, self.__doc__)
class FieldListFile(object):
__slots__ = ("_fields", "filename")
def __init__(self, **kwargs):
"""
Represent a predefined set of keys with the associated value.
The constructor build the object assigning every keyword argument to
the corresponding attribute. If a provided keyword argument doesn't
has a corresponding attribute an AttributeError exception is raised.
The values provided to the constructor must be of the appropriate
type for the corresponding attribute.
The constructor will not attempt any validation or conversion on them.
This class is meant to be an abstract base class.
:raises: AttributeError
"""
self._fields = {}
self.filename = None
for name in kwargs:
field = getattr(type(self), name, None)
if isinstance(field, Field):
setattr(self, name, kwargs[name])
else:
raise AttributeError("unknown attribute %s" % name)
@classmethod
def from_meta_file(cls, filename):
"""
Factory method that read the specified file and build
an object with its content.
:param str filename: the file to read
"""
o = cls()
o.load(filename)
return o
def save(self, filename=None, file_object=None):
"""
Serialize the object to the specified file or file object
If a file_object is specified it will be used.
If the filename is not specified it uses the one memorized in the
filename attribute. If neither the filename attribute and parameter are
set a ValueError exception is raised.
:param str filename: path of the file to write
:param file file_object: a file like object to write in
:param str filename: the file to write
:raises: ValueError
"""
if file_object:
info = file_object
else:
filename = filename or self.filename
if filename:
info = open(filename + ".tmp", "wb")
else:
info = None
if not info:
raise ValueError(
"either a valid filename or a file_object must be specified"
)
try:
for name, field in sorted(inspect.getmembers(type(self))):
value = getattr(self, name, None)
if isinstance(field, Field):
if callable(field.to_str):
value = field.to_str(value)
info.write(("%s=%s\n" % (name, value)).encode("UTF-8"))
finally:
if not file_object:
info.close()
if not file_object:
os.rename(filename + ".tmp", filename)
fsync_dir(os.path.normpath(os.path.dirname(filename)))
def load(self, filename=None, file_object=None):
"""
Replaces the current object content with the one deserialized from
the provided file.
This method set the filename attribute.
A ValueError exception is raised if the provided file contains any
invalid line.
:param str filename: path of the file to read
:param file file_object: a file like object to read from
:param str filename: the file to read
:raises: ValueError
"""
if file_object:
info = file_object
elif filename:
info = open(filename, "rb")
else:
raise ValueError("either filename or file_object must be specified")
# detect the filename if a file_object is passed
if not filename and file_object:
if hasattr(file_object, "name"):
filename = file_object.name
# canonicalize filename
if filename:
self.filename = os.path.abspath(filename)
else:
self.filename = None
filename = "" # This is only for error reporting
with info:
for line in info:
line = line.decode("UTF-8")
# skip spaces and comments
if line.isspace() or line.rstrip().startswith("#"):
continue
# parse the line of form "key = value"
try:
name, value = [x.strip() for x in line.split("=", 1)]
except ValueError:
raise ValueError(
"invalid line %s in file %s" % (line.strip(), filename)
)
# use the from_str function to parse the value
field = getattr(type(self), name, None)
if value == "None":
value = None
elif isinstance(field, Field) and callable(field.from_str):
value = field.from_str(value)
setattr(self, name, value)
def items(self):
"""
Return a generator returning a list of (key, value) pairs.
If a filed has a dump function defined, it will be used.
"""
for name, field in sorted(inspect.getmembers(type(self))):
value = getattr(self, name, None)
if isinstance(field, Field):
if callable(field.to_str):
value = field.to_str(value)
yield (name, value)
def __repr__(self):
return "%s(%s)" % (
self.__class__.__name__,
", ".join(["%s=%r" % x for x in self.items()]),
)
class WalFileInfo(FieldListFile):
"""
Metadata of a WAL file.
"""
__slots__ = ("orig_filename",)
name = Field("name", doc="base name of WAL file")
size = Field("size", load=int, doc="WAL file size after compression")
time = Field(
"time", load=float, doc="WAL file modification time (seconds since epoch)"
)
compression = Field("compression", doc="compression type")
@classmethod
def from_file(
cls, filename, compression_manager=None, unidentified_compression=None, **kwargs
):
"""
Factory method to generate a WalFileInfo from a WAL file.
Every keyword argument will override any attribute from the provided
file. If a keyword argument doesn't has a corresponding attribute
an AttributeError exception is raised.
:param str filename: the file to inspect
:param Compressionmanager compression_manager: a compression manager
which will be used to identify the compression
:param str unidentified_compression: the compression to set if
the current schema is not identifiable
"""
stat = os.stat(filename)
kwargs.setdefault("name", os.path.basename(filename))
kwargs.setdefault("size", stat.st_size)
kwargs.setdefault("time", stat.st_mtime)
if "compression" not in kwargs:
kwargs["compression"] = (
compression_manager.identify_compression(filename)
or unidentified_compression
)
obj = cls(**kwargs)
obj.filename = "%s.meta" % filename
obj.orig_filename = filename
return obj
def to_xlogdb_line(self):
"""
Format the content of this object as a xlogdb line.
"""
return "%s\t%s\t%s\t%s\n" % (self.name, self.size, self.time, self.compression)
@classmethod
def from_xlogdb_line(cls, line):
"""
Parse a line from xlog catalogue
:param str line: a line in the wal database to parse
:rtype: WalFileInfo
"""
try:
name, size, time, compression = line.split()
except ValueError:
# Old format compatibility (no compression)
compression = None
try:
name, size, time = line.split()
except ValueError:
raise ValueError("cannot parse line: %r" % (line,))
# The to_xlogdb_line method writes None values as literal 'None'
if compression == "None":
compression = None
size = int(size)
time = float(time)
return cls(name=name, size=size, time=time, compression=compression)
def to_json(self):
"""
Return an equivalent dictionary that can be encoded in json
"""
return dict(self.items())
def relpath(self):
"""
Returns the WAL file path relative to the server's wals_directory
"""
return os.path.join(xlog.hash_dir(self.name), self.name)
def fullpath(self, server):
"""
Returns the WAL file full path
:param barman.server.Server server: the server that owns the wal file
"""
return os.path.join(server.config.wals_directory, self.relpath())
class BackupInfo(FieldListFile):
#: Conversion to string
EMPTY = "EMPTY"
STARTED = "STARTED"
FAILED = "FAILED"
WAITING_FOR_WALS = "WAITING_FOR_WALS"
DONE = "DONE"
SYNCING = "SYNCING"
STATUS_COPY_DONE = (WAITING_FOR_WALS, DONE)
STATUS_ALL = (EMPTY, STARTED, WAITING_FOR_WALS, DONE, SYNCING, FAILED)
STATUS_NOT_EMPTY = (STARTED, WAITING_FOR_WALS, DONE, SYNCING, FAILED)
STATUS_ARCHIVING = (STARTED, WAITING_FOR_WALS, DONE, SYNCING)
#: Status according to retention policies
OBSOLETE = "OBSOLETE"
VALID = "VALID"
POTENTIALLY_OBSOLETE = "OBSOLETE*"
NONE = "-"
KEEP_FULL = "KEEP:FULL"
KEEP_STANDALONE = "KEEP:STANDALONE"
RETENTION_STATUS = (
OBSOLETE,
VALID,
POTENTIALLY_OBSOLETE,
KEEP_FULL,
KEEP_STANDALONE,
NONE,
)
version = Field("version", load=int)
pgdata = Field("pgdata")
# Parse the tablespaces as a literal Python list of namedtuple
# Output the tablespaces as a literal Python list of tuple
tablespaces = Field(
"tablespaces", load=load_tablespace_list, dump=output_tablespace_list
)
# Timeline is an integer
timeline = Field("timeline", load=int)
begin_time = Field("begin_time", load=load_datetime_tz)
begin_xlog = Field("begin_xlog")
begin_wal = Field("begin_wal")
begin_offset = Field("begin_offset", load=int)
size = Field("size", load=int)
deduplicated_size = Field("deduplicated_size", load=int)
end_time = Field("end_time", load=load_datetime_tz)
end_xlog = Field("end_xlog")
end_wal = Field("end_wal")
end_offset = Field("end_offset", load=int)
status = Field("status", default=EMPTY)
server_name = Field("server_name")
error = Field("error")
mode = Field("mode")
config_file = Field("config_file")
hba_file = Field("hba_file")
ident_file = Field("ident_file")
included_files = Field("included_files", load=ast.literal_eval, dump=null_repr)
backup_label = Field("backup_label", load=ast.literal_eval, dump=null_repr)
copy_stats = Field("copy_stats", load=ast.literal_eval, dump=null_repr)
xlog_segment_size = Field(
"xlog_segment_size", load=int, default=xlog.DEFAULT_XLOG_SEG_SIZE
)
systemid = Field("systemid")
__slots__ = "backup_id", "backup_version"
def __init__(self, backup_id, **kwargs):
"""
Stores meta information about a single backup
:param str,None backup_id:
"""
self.backup_version = 2
self.backup_id = backup_id
super(BackupInfo, self).__init__(**kwargs)
def get_required_wal_segments(self):
"""
Get the list of required WAL segments for the current backup
"""
return xlog.generate_segment_names(
self.begin_wal, self.end_wal, self.version, self.xlog_segment_size
)
def get_external_config_files(self):
"""
Identify all the configuration files that reside outside the PGDATA.
Returns a list of TypedFile objects.
:rtype: list[TypedFile]
"""
config_files = []
for file_type in ("config_file", "hba_file", "ident_file"):
config_file = getattr(self, file_type, None)
if config_file:
# Consider only those that reside outside of the original
# PGDATA directory
if config_file.startswith(self.pgdata):
_logger.debug(
"Config file '%s' already in PGDATA",
config_file[len(self.pgdata) + 1 :],
)
continue
config_files.append(TypedFile(file_type, config_file))
# Check for any include directives in PostgreSQL configuration
# Currently, include directives are not supported for files that
# reside outside PGDATA. These files must be manually backed up.
# Barman will emit a warning and list those files
if self.included_files:
for included_file in self.included_files:
if not included_file.startswith(self.pgdata):
config_files.append(TypedFile("include", included_file))
return config_files
def set_attribute(self, key, value):
"""
Set a value for a given key
"""
setattr(self, key, value)
def to_dict(self):
"""
Return the backup_info content as a simple dictionary
:return dict:
"""
result = dict(self.items())
result.update(
backup_id=self.backup_id,
server_name=self.server_name,
mode=self.mode,
tablespaces=self.tablespaces,
included_files=self.included_files,
copy_stats=self.copy_stats,
)
return result
def to_json(self):
"""
Return an equivalent dictionary that uses only json-supported types
"""
data = self.to_dict()
# Convert fields which need special types not supported by json
if data.get("tablespaces") is not None:
data["tablespaces"] = [list(item) for item in data["tablespaces"]]
if data.get("begin_time") is not None:
data["begin_time"] = data["begin_time"].ctime()
if data.get("end_time") is not None:
data["end_time"] = data["end_time"].ctime()
return data
@classmethod
def from_json(cls, server, json_backup_info):
"""
Factory method that builds a BackupInfo object
from a json dictionary
:param barman.Server server: the server related to the Backup
:param dict json_backup_info: the data set containing values from json
"""
data = dict(json_backup_info)
# Convert fields which need special types not supported by json
if data.get("tablespaces") is not None:
data["tablespaces"] = [
Tablespace._make(item) for item in data["tablespaces"]
]
if data.get("begin_time") is not None:
data["begin_time"] = load_datetime_tz(data["begin_time"])
if data.get("end_time") is not None:
data["end_time"] = load_datetime_tz(data["end_time"])
# Instantiate a BackupInfo object using the converted fields
return cls(server, **data)
def pg_major_version(self):
"""
Returns the major version of the PostgreSQL instance from which the
backup was made taking into account the change in versioning scheme
between PostgreSQL < 10.0 and PostgreSQL >= 10.0.
"""
major = int(self.version / 10000)
if major < 10:
minor = int(self.version / 100 % 100)
return "%d.%d" % (major, minor)
else:
return str(major)
def wal_directory(self):
"""
Returns "pg_wal" (v10 and above) or "pg_xlog" (v9.6 and below) based on
the Postgres version represented by this backup
"""
return "pg_wal" if self.version >= 100000 else "pg_xlog"
class LocalBackupInfo(BackupInfo):
__slots__ = "server", "config", "backup_manager"
def __init__(self, server, info_file=None, backup_id=None, **kwargs):
"""
Stores meta information about a single backup
:param Server server:
:param file,str,None info_file:
:param str,None backup_id:
:raise BackupInfoBadInitialisation: if the info_file content is invalid
or neither backup_info or
"""
# Initialises the attributes for the object
# based on the predefined keys
super(LocalBackupInfo, self).__init__(backup_id=backup_id, **kwargs)
self.server = server
self.config = server.config
self.backup_manager = self.server.backup_manager
self.server_name = self.config.name
self.mode = self.backup_manager.mode
if backup_id:
# Cannot pass both info_file and backup_id
if info_file:
raise BackupInfoBadInitialisation(
"both info_file and backup_id parameters are set"
)
self.backup_id = backup_id
self.filename = self.get_filename()
# Check if a backup info file for a given server and a given ID
# already exists. If so load the values from the file.
if os.path.exists(self.filename):
self.load(filename=self.filename)
elif info_file:
if hasattr(info_file, "read"):
# We have been given a file-like object
self.load(file_object=info_file)
else:
# Just a file name
self.load(filename=info_file)
self.backup_id = self.detect_backup_id()
elif not info_file:
raise BackupInfoBadInitialisation(
"backup_id and info_file parameters are both unset"
)
# Manage backup version for new backup structure
try:
# the presence of pgdata directory is the marker of version 1
if self.backup_id is not None and os.path.exists(
os.path.join(self.get_basebackup_directory(), "pgdata")
):
self.backup_version = 1
except Exception as e:
_logger.warning(
"Error detecting backup_version, use default: 2. Failure reason: %s",
e,
)
def get_list_of_files(self, target):
"""
Get the list of files for the current backup
"""
# Walk down the base backup directory
if target in ("data", "standalone", "full"):
for root, _, files in os.walk(self.get_basebackup_directory()):
files.sort()
for f in files:
yield os.path.join(root, f)
if target in "standalone":
# List all the WAL files for this backup
for x in self.get_required_wal_segments():
yield self.server.get_wal_full_path(x)
if target in ("wal", "full"):
for wal_info in self.server.get_wal_until_next_backup(
self, include_history=True
):
yield wal_info.fullpath(self.server)
def detect_backup_id(self):
"""
Detect the backup ID from the name of the parent dir of the info file
"""
if self.filename:
return os.path.basename(os.path.dirname(self.filename))
else:
return None
def get_basebackup_directory(self):
"""
Get the default filename for the backup.info file based on
backup ID and server directory for base backups
"""
return os.path.join(self.config.basebackups_directory, self.backup_id)
def get_data_directory(self, tablespace_oid=None):
"""
Get path to the backup data dir according with the backup version
If tablespace_oid is passed, build the path to the tablespace
base directory, according with the backup version
:param int tablespace_oid: the oid of a valid tablespace
"""
# Check if a tablespace oid is passed and if is a valid oid
if tablespace_oid is not None:
if self.tablespaces is None:
raise ValueError("Invalid tablespace OID %s" % tablespace_oid)
invalid_oid = all(
str(tablespace_oid) != str(tablespace.oid)
for tablespace in self.tablespaces
)
if invalid_oid:
raise ValueError("Invalid tablespace OID %s" % tablespace_oid)
# Build the requested path according to backup_version value
path = [self.get_basebackup_directory()]
# Check the version of the backup
if self.backup_version == 2:
# If an oid has been provided, we are looking for a tablespace
if tablespace_oid is not None:
# Append the oid to the basedir of the backup
path.append(str(tablespace_oid))
else:
# Looking for the data dir
path.append("data")
else:
# Backup v1, use pgdata as base
path.append("pgdata")
# If a oid has been provided, we are looking for a tablespace.
if tablespace_oid is not None:
# Append the path to pg_tblspc/oid folder inside pgdata
path.extend(("pg_tblspc", str(tablespace_oid)))
# Return the built path
return os.path.join(*path)
def get_filename(self):
"""
Get the default filename for the backup.info file based on
backup ID and server directory for base backups
"""
return os.path.join(self.get_basebackup_directory(), "backup.info")
def save(self, filename=None, file_object=None):
if not file_object:
# Make sure the containing directory exists
filename = filename or self.filename
dir_name = os.path.dirname(filename)
if not os.path.exists(dir_name):
os.makedirs(dir_name)
super(LocalBackupInfo, self).save(filename=filename, file_object=file_object)
barman-2.18/barman/backup_executor.py 0000644 0006212 0006212 00000215370 14172556763 016105 0 ustar 0000000 0000000 # -*- coding: utf-8 -*-
# © Copyright EnterpriseDB UK Limited 2011-2022
#
# This file is part of Barman.
#
# Barman is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Barman is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Barman. If not, see .
"""
Backup Executor module
A Backup Executor is a class responsible for the execution
of a backup. Specific implementations of backups are defined by
classes that derive from BackupExecutor (e.g.: backup with rsync
through Ssh).
A BackupExecutor is invoked by the BackupManager for backup operations.
"""
import datetime
import logging
import os
import re
import shutil
from abc import ABCMeta, abstractmethod
from functools import partial
import dateutil.parser
from distutils.version import LooseVersion as Version
from barman import output, xlog
from barman.command_wrappers import PgBaseBackup
from barman.config import BackupOptions
from barman.copy_controller import RsyncCopyController
from barman.exceptions import (
CommandFailedException,
DataTransferFailure,
FsOperationFailed,
PostgresConnectionError,
PostgresIsInRecovery,
SshCommandException,
)
from barman.fs import UnixLocalCommand, UnixRemoteCommand
from barman.infofile import BackupInfo
from barman.postgres_plumbing import EXCLUDE_LIST, PGDATA_EXCLUDE_LIST
from barman.remote_status import RemoteStatusMixin
from barman.utils import (
force_str,
human_readable_timedelta,
mkpath,
total_seconds,
with_metaclass,
)
_logger = logging.getLogger(__name__)
class BackupExecutor(with_metaclass(ABCMeta, RemoteStatusMixin)):
"""
Abstract base class for any backup executors.
"""
def __init__(self, backup_manager, mode=None):
"""
Base constructor
:param barman.backup.BackupManager backup_manager: the BackupManager
assigned to the executor
"""
super(BackupExecutor, self).__init__()
self.backup_manager = backup_manager
self.server = backup_manager.server
self.config = backup_manager.config
self.strategy = None
self._mode = mode
self.copy_start_time = None
self.copy_end_time = None
# Holds the action being executed. Used for error messages.
self.current_action = None
def init(self):
"""
Initialise the internal state of the backup executor
"""
self.current_action = "starting backup"
@property
def mode(self):
"""
Property that defines the mode used for the backup.
If a strategy is present, the returned string is a combination
of the mode of the executor and the mode of the strategy
(eg: rsync-exclusive)
:return str: a string describing the mode used for the backup
"""
strategy_mode = self.strategy.mode
if strategy_mode:
return "%s-%s" % (self._mode, strategy_mode)
else:
return self._mode
@abstractmethod
def backup(self, backup_info):
"""
Perform a backup for the server - invoked by BackupManager.backup()
:param barman.infofile.LocalBackupInfo backup_info: backup information
"""
def check(self, check_strategy):
"""
Perform additional checks - invoked by BackupManager.check()
:param CheckStrategy check_strategy: the strategy for the management
of the results of the various checks
"""
def status(self):
"""
Set additional status info - invoked by BackupManager.status()
"""
def fetch_remote_status(self):
"""
Get additional remote status info - invoked by
BackupManager.get_remote_status()
This method does not raise any exception in case of errors,
but set the missing values to None in the resulting dictionary.
:rtype: dict[str, None|str]
"""
return {}
def _purge_unused_wal_files(self, backup_info):
"""
It the provided backup is the first, purge all WAL files before the
backup start.
:param barman.infofile.LocalBackupInfo backup_info: the backup to check
"""
# Do nothing if the begin_wal is not defined yet
if backup_info.begin_wal is None:
return
# If this is the first backup, purge unused WAL files
previous_backup = self.backup_manager.get_previous_backup(backup_info.backup_id)
if not previous_backup:
output.info("This is the first backup for server %s", self.config.name)
removed = self.backup_manager.remove_wal_before_backup(backup_info)
if removed:
# report the list of the removed WAL files
output.info(
"WAL segments preceding the current backup have been found:",
log=False,
)
for wal_name in removed:
output.info(
"\t%s from server %s has been removed",
wal_name,
self.config.name,
)
def _start_backup_copy_message(self, backup_info):
"""
Output message for backup start
:param barman.infofile.LocalBackupInfo backup_info: backup information
"""
output.info("Copying files for %s", backup_info.backup_id)
def _stop_backup_copy_message(self, backup_info):
"""
Output message for backup end
:param barman.infofile.LocalBackupInfo backup_info: backup information
"""
output.info(
"Copy done (time: %s)",
human_readable_timedelta(
datetime.timedelta(seconds=backup_info.copy_stats["copy_time"])
),
)
def _parse_ssh_command(ssh_command):
"""
Parse a user provided ssh command to a single command and
a list of arguments
In case of error, the first member of the result (the command) will be None
:param ssh_command: a ssh command provided by the user
:return tuple[str,list[str]]: the command and a list of options
"""
try:
ssh_options = ssh_command.split()
except AttributeError:
return None, []
ssh_command = ssh_options.pop(0)
ssh_options.extend("-o BatchMode=yes -o StrictHostKeyChecking=no".split())
return ssh_command, ssh_options
class PostgresBackupExecutor(BackupExecutor):
"""
Concrete class for backup via pg_basebackup (plain format).
Relies on pg_basebackup command to copy data files from the PostgreSQL
cluster using replication protocol.
"""
def __init__(self, backup_manager):
"""
Constructor
:param barman.backup.BackupManager backup_manager: the BackupManager
assigned to the executor
"""
super(PostgresBackupExecutor, self).__init__(backup_manager, "postgres")
self.validate_configuration()
self.strategy = PostgresBackupStrategy(self.server.postgres, self.config.name)
def validate_configuration(self):
"""
Validate the configuration for this backup executor.
If the configuration is not compatible this method will disable the
server.
"""
# Check for the correct backup options
if BackupOptions.EXCLUSIVE_BACKUP in self.config.backup_options:
self.config.backup_options.remove(BackupOptions.EXCLUSIVE_BACKUP)
output.warning(
"'exclusive_backup' is not a valid backup_option "
"using postgres backup_method. "
"Overriding with 'concurrent_backup'."
)
# Apply the default backup strategy
if BackupOptions.CONCURRENT_BACKUP not in self.config.backup_options:
self.config.backup_options.add(BackupOptions.CONCURRENT_BACKUP)
output.debug(
"The default backup strategy for "
"postgres backup_method is: concurrent_backup"
)
# Forbid tablespace_bandwidth_limit option.
# It works only with rsync based backups.
if self.config.tablespace_bandwidth_limit:
self.server.config.disabled = True
# Report the error in the configuration errors message list
self.server.config.msg_list.append(
"tablespace_bandwidth_limit option is not supported by "
"postgres backup_method"
)
# Forbid reuse_backup option.
# It works only with rsync based backups.
if self.config.reuse_backup in ("copy", "link"):
self.server.config.disabled = True
# Report the error in the configuration errors message list
self.server.config.msg_list.append(
"reuse_backup option is not supported by postgres backup_method"
)
# Forbid network_compression option.
# It works only with rsync based backups.
if self.config.network_compression:
self.server.config.disabled = True
# Report the error in the configuration errors message list
self.server.config.msg_list.append(
"network_compression option is not supported by "
"postgres backup_method"
)
# bandwidth_limit option is supported by pg_basebackup executable
# starting from Postgres 9.4
if self.server.config.bandwidth_limit:
# This method is invoked too early to have a working streaming
# connection. So we avoid caching the result by directly
# invoking fetch_remote_status() instead of get_remote_status()
remote_status = self.fetch_remote_status()
# If pg_basebackup is present and it doesn't support bwlimit
# disable the server.
if remote_status["pg_basebackup_bwlimit"] is False:
self.server.config.disabled = True
# Report the error in the configuration errors message list
self.server.config.msg_list.append(
"bandwidth_limit option is not supported by "
"pg_basebackup version (current: %s, required: 9.4)"
% remote_status["pg_basebackup_version"]
)
def backup(self, backup_info):
"""
Perform a backup for the server - invoked by BackupManager.backup()
through the generic interface of a BackupExecutor.
This implementation is responsible for performing a backup through the
streaming protocol.
The connection must be made with a superuser or a user having
REPLICATION permissions (see PostgreSQL documentation, Section 20.2),
and pg_hba.conf must explicitly permit the replication connection.
The server must also be configured with enough max_wal_senders to leave
at least one session available for the backup.
:param barman.infofile.LocalBackupInfo backup_info: backup information
"""
try:
# Set data directory and server version
self.strategy.start_backup(backup_info)
backup_info.save()
if backup_info.begin_wal is not None:
output.info(
"Backup start at LSN: %s (%s, %08X)",
backup_info.begin_xlog,
backup_info.begin_wal,
backup_info.begin_offset,
)
else:
output.info("Backup start at LSN: %s", backup_info.begin_xlog)
# Start the copy
self.current_action = "copying files"
self._start_backup_copy_message(backup_info)
self.backup_copy(backup_info)
self._stop_backup_copy_message(backup_info)
self.strategy.stop_backup(backup_info)
# If this is the first backup, purge eventually unused WAL files
self._purge_unused_wal_files(backup_info)
except CommandFailedException as e:
_logger.exception(e)
raise
def check(self, check_strategy):
"""
Perform additional checks for PostgresBackupExecutor
:param CheckStrategy check_strategy: the strategy for the management
of the results of the various checks
"""
check_strategy.init_check("pg_basebackup")
remote_status = self.get_remote_status()
# Check for the presence of pg_basebackup
check_strategy.result(
self.config.name, remote_status["pg_basebackup_installed"]
)
# remote_status['pg_basebackup_compatible'] is None if
# pg_basebackup cannot be executed and False if it is
# not compatible.
hint = None
check_strategy.init_check("pg_basebackup compatible")
if not remote_status["pg_basebackup_compatible"]:
pg_version = "Unknown"
basebackup_version = "Unknown"
if self.server.streaming is not None:
pg_version = self.server.streaming.server_txt_version
if remote_status["pg_basebackup_version"] is not None:
basebackup_version = remote_status["pg_basebackup_version"]
hint = "PostgreSQL version: %s, pg_basebackup version: %s" % (
pg_version,
basebackup_version,
)
check_strategy.result(
self.config.name, remote_status["pg_basebackup_compatible"], hint=hint
)
# Skip further checks if the postgres connection doesn't work.
# We assume that this error condition will be reported by
# another check.
postgres = self.server.postgres
if postgres is None or postgres.server_txt_version is None:
return
check_strategy.init_check("pg_basebackup supports tablespaces mapping")
# We can't backup a cluster with tablespaces if the tablespace
# mapping option is not available in the installed version
# of pg_basebackup.
pg_version = Version(postgres.server_txt_version)
tablespaces_list = postgres.get_tablespaces()
# pg_basebackup supports the tablespace-mapping option,
# so there are no problems in this case
if remote_status["pg_basebackup_tbls_mapping"]:
hint = None
check_result = True
# pg_basebackup doesn't support the tablespace-mapping option
# and the data directory contains tablespaces, we can't correctly
# backup it.
elif tablespaces_list:
check_result = False
if pg_version < "9.3":
hint = (
"pg_basebackup can't be used with tablespaces "
"and PostgreSQL older than 9.3"
)
else:
hint = "pg_basebackup 9.4 or higher is required for tablespaces support"
# Even if pg_basebackup doesn't support the tablespace-mapping
# option, this location can be correctly backed up as doesn't
# have any tablespaces
else:
check_result = True
if pg_version < "9.3":
hint = (
"pg_basebackup can be used as long as tablespaces "
"support is not required"
)
else:
hint = "pg_basebackup 9.4 or higher is required for tablespaces support"
check_strategy.result(self.config.name, check_result, hint=hint)
def fetch_remote_status(self):
"""
Gather info from the remote server.
This method does not raise any exception in case of errors,
but set the missing values to None in the resulting dictionary.
"""
remote_status = dict.fromkeys(
(
"pg_basebackup_compatible",
"pg_basebackup_installed",
"pg_basebackup_tbls_mapping",
"pg_basebackup_path",
"pg_basebackup_bwlimit",
"pg_basebackup_version",
),
None,
)
# Test pg_basebackup existence
version_info = PgBaseBackup.get_version_info(self.server.path)
if version_info["full_path"]:
remote_status["pg_basebackup_installed"] = True
remote_status["pg_basebackup_path"] = version_info["full_path"]
remote_status["pg_basebackup_version"] = version_info["full_version"]
pgbasebackup_version = version_info["major_version"]
else:
remote_status["pg_basebackup_installed"] = False
return remote_status
# Is bandwidth limit supported?
if (
remote_status["pg_basebackup_version"] is not None
and remote_status["pg_basebackup_version"] < "9.4"
):
remote_status["pg_basebackup_bwlimit"] = False
else:
remote_status["pg_basebackup_bwlimit"] = True
# Is the tablespace mapping option supported?
if pgbasebackup_version >= "9.4":
remote_status["pg_basebackup_tbls_mapping"] = True
else:
remote_status["pg_basebackup_tbls_mapping"] = False
# Retrieve the PostgreSQL version
pg_version = None
if self.server.streaming is not None:
pg_version = self.server.streaming.server_major_version
# If any of the two versions is unknown, we can't compare them
if pgbasebackup_version is None or pg_version is None:
# Return here. We are unable to retrieve
# pg_basebackup or PostgreSQL versions
return remote_status
# pg_version is not None so transform into a Version object
# for easier comparison between versions
pg_version = Version(pg_version)
# pg_basebackup 9.2 is compatible only with PostgreSQL 9.2.
if "9.2" == pg_version == pgbasebackup_version:
remote_status["pg_basebackup_compatible"] = True
# other versions are compatible with lesser versions of PostgreSQL
# WARNING: The development versions of `pg_basebackup` are considered
# higher than the stable versions here, but this is not an issue
# because it accepts everything that is less than
# the `pg_basebackup` version(e.g. '9.6' is less than '9.6devel')
elif "9.2" < pg_version <= pgbasebackup_version:
remote_status["pg_basebackup_compatible"] = True
else:
remote_status["pg_basebackup_compatible"] = False
return remote_status
def backup_copy(self, backup_info):
"""
Perform the actual copy of the backup using pg_basebackup.
First, manages tablespaces, then copies the base backup
using the streaming protocol.
In case of failure during the execution of the pg_basebackup command
the method raises a DataTransferFailure, this trigger the retrying
mechanism when necessary.
:param barman.infofile.LocalBackupInfo backup_info: backup information
"""
# Make sure the destination directory exists, ensure the
# right permissions to the destination dir
backup_dest = backup_info.get_data_directory()
dest_dirs = [backup_dest]
# Store the start time
self.copy_start_time = datetime.datetime.now()
# Manage tablespaces, we need to handle them now in order to
# be able to relocate them inside the
# destination directory of the basebackup
tbs_map = {}
if backup_info.tablespaces:
for tablespace in backup_info.tablespaces:
source = tablespace.location
destination = backup_info.get_data_directory(tablespace.oid)
tbs_map[source] = destination
dest_dirs.append(destination)
# Prepare the destination directories for pgdata and tablespaces
self._prepare_backup_destination(dest_dirs)
# Retrieve pg_basebackup version information
remote_status = self.get_remote_status()
# If pg_basebackup supports --max-rate set the bandwidth_limit
bandwidth_limit = None
if remote_status["pg_basebackup_bwlimit"]:
bandwidth_limit = self.config.bandwidth_limit
# Make sure we are not wasting precious PostgreSQL resources
# for the whole duration of the copy
self.server.close()
pg_basebackup = PgBaseBackup(
connection=self.server.streaming,
destination=backup_dest,
command=remote_status["pg_basebackup_path"],
version=remote_status["pg_basebackup_version"],
app_name=self.config.streaming_backup_name,
tbs_mapping=tbs_map,
bwlimit=bandwidth_limit,
immediate=self.config.immediate_checkpoint,
path=self.server.path,
retry_times=self.config.basebackup_retry_times,
retry_sleep=self.config.basebackup_retry_sleep,
retry_handler=partial(self._retry_handler, dest_dirs),
)
# Do the actual copy
try:
pg_basebackup()
except CommandFailedException as e:
msg = (
"data transfer failure on directory '%s'"
% backup_info.get_data_directory()
)
raise DataTransferFailure.from_command_error("pg_basebackup", e, msg)
# Store the end time
self.copy_end_time = datetime.datetime.now()
# Store statistics about the copy
copy_time = total_seconds(self.copy_end_time - self.copy_start_time)
backup_info.copy_stats = {
"copy_time": copy_time,
"total_time": copy_time,
}
# Check for the presence of configuration files outside the PGDATA
external_config = backup_info.get_external_config_files()
if any(external_config):
msg = (
"pg_basebackup does not copy the PostgreSQL "
"configuration files that reside outside PGDATA. "
"Please manually backup the following files:\n"
"\t%s\n" % "\n\t".join(ecf.path for ecf in external_config)
)
# Show the warning only if the EXTERNAL_CONFIGURATION option
# is not specified in the backup_options.
if BackupOptions.EXTERNAL_CONFIGURATION not in self.config.backup_options:
output.warning(msg)
else:
_logger.debug(msg)
def _retry_handler(self, dest_dirs, command, args, kwargs, attempt, exc):
"""
Handler invoked during a backup in case of retry.
The method simply warn the user of the failure and
remove the already existing directories of the backup.
:param list[str] dest_dirs: destination directories
:param RsyncPgData command: Command object being executed
:param list args: command args
:param dict kwargs: command kwargs
:param int attempt: attempt number (starting from 0)
:param CommandFailedException exc: the exception which caused the
failure
"""
output.warning(
"Failure executing a backup using pg_basebackup (attempt %s)", attempt
)
output.warning(
"The files copied so far will be removed and "
"the backup process will restart in %s seconds",
self.config.basebackup_retry_sleep,
)
# Remove all the destination directories and reinit the backup
self._prepare_backup_destination(dest_dirs)
def _prepare_backup_destination(self, dest_dirs):
"""
Prepare the destination of the backup, including tablespaces.
This method is also responsible for removing a directory if
it already exists and for ensuring the correct permissions for
the created directories
:param list[str] dest_dirs: destination directories
"""
for dest_dir in dest_dirs:
# Remove a dir if exists. Ignore eventual errors
shutil.rmtree(dest_dir, ignore_errors=True)
# create the dir
mkpath(dest_dir)
# Ensure the right permissions to the destination directory
# chmod 0700 octal
os.chmod(dest_dir, 448)
def _start_backup_copy_message(self, backup_info):
output.info(
"Starting backup copy via pg_basebackup for %s", backup_info.backup_id
)
class FsBackupExecutor(with_metaclass(ABCMeta, BackupExecutor)):
"""
Abstract base class file system level backup executors that
can operate remotely via SSH or locally:
- remote mode (default), operates via SSH
- local mode, operates as the same user that Barman runs with
It is also a factory for exclusive/concurrent backup strategy objects.
Raises a SshCommandException if 'ssh_command' is not set and
not operating in local mode.
"""
def __init__(self, backup_manager, mode, local_mode=False):
"""
Constructor of the abstract class for backups via Ssh
:param barman.backup.BackupManager backup_manager: the BackupManager
assigned to the executor
:param bool local_mode: if set to False (default), the class is able
to operate on remote servers using SSH. Operates only locally
if set to True.
"""
super(FsBackupExecutor, self).__init__(backup_manager, mode)
# Set local/remote mode for copy
self.local_mode = local_mode
# Retrieve the ssh command and the options necessary for the
# remote ssh access.
self.ssh_command, self.ssh_options = _parse_ssh_command(
backup_manager.config.ssh_command
)
if not self.local_mode:
# Remote copy requires ssh_command to be set
if not self.ssh_command:
raise SshCommandException(
"Missing or invalid ssh_command in barman configuration "
"for server %s" % backup_manager.config.name
)
else:
# Local copy requires ssh_command not to be set
if self.ssh_command:
raise SshCommandException(
"Local copy requires ssh_command in barman configuration "
"to be empty for server %s" % backup_manager.config.name
)
# Apply the default backup strategy
backup_options = self.config.backup_options
concurrent_backup = BackupOptions.CONCURRENT_BACKUP in backup_options
exclusive_backup = BackupOptions.EXCLUSIVE_BACKUP in backup_options
if not concurrent_backup and not exclusive_backup:
self.config.backup_options.add(BackupOptions.EXCLUSIVE_BACKUP)
output.warning(
"No backup strategy set for server '%s' "
"(using default 'exclusive_backup').",
self.config.name,
)
output.warning(
"The default backup strategy will change "
"to 'concurrent_backup' in the future. "
"Explicitly set 'backup_options' to silence this warning."
)
# Depending on the backup options value, create the proper strategy
if BackupOptions.CONCURRENT_BACKUP in self.config.backup_options:
# Concurrent backup strategy
self.strategy = LocalConcurrentBackupStrategy(
self.server.postgres, self.config.name
)
else:
# Exclusive backup strategy
self.strategy = ExclusiveBackupStrategy(
self.server.postgres, self.config.name
)
def _update_action_from_strategy(self):
"""
Update the executor's current action with the one of the strategy.
This is used during exception handling to let the caller know
where the failure occurred.
"""
action = getattr(self.strategy, "current_action", None)
if action:
self.current_action = action
@abstractmethod
def backup_copy(self, backup_info):
"""
Performs the actual copy of a backup for the server
:param barman.infofile.LocalBackupInfo backup_info: backup information
"""
def backup(self, backup_info):
"""
Perform a backup for the server - invoked by BackupManager.backup()
through the generic interface of a BackupExecutor. This implementation
is responsible for performing a backup through a remote connection
to the PostgreSQL server via Ssh. The specific set of instructions
depends on both the specific class that derives from FsBackupExecutor
and the selected strategy (e.g. exclusive backup through Rsync).
:param barman.infofile.LocalBackupInfo backup_info: backup information
"""
# Start the backup, all the subsequent code must be wrapped in a
# try except block which finally issues a stop_backup command
try:
self.strategy.start_backup(backup_info)
except BaseException:
self._update_action_from_strategy()
raise
try:
# save any metadata changed by start_backup() call
# This must be inside the try-except, because it could fail
backup_info.save()
if backup_info.begin_wal is not None:
output.info(
"Backup start at LSN: %s (%s, %08X)",
backup_info.begin_xlog,
backup_info.begin_wal,
backup_info.begin_offset,
)
else:
output.info("Backup start at LSN: %s", backup_info.begin_xlog)
# If this is the first backup, purge eventually unused WAL files
self._purge_unused_wal_files(backup_info)
# Start the copy
self.current_action = "copying files"
self._start_backup_copy_message(backup_info)
self.backup_copy(backup_info)
self._stop_backup_copy_message(backup_info)
# Try again to purge eventually unused WAL files. At this point
# the begin_wal value is surely known. Doing it twice is safe
# because this function is useful only during the first backup.
self._purge_unused_wal_files(backup_info)
except BaseException:
# we do not need to do anything here besides re-raising the
# exception. It will be handled in the external try block.
output.error("The backup has failed %s", self.current_action)
raise
else:
self.current_action = "issuing stop of the backup"
finally:
output.info("Asking PostgreSQL server to finalize the backup.")
try:
self.strategy.stop_backup(backup_info)
except BaseException:
self._update_action_from_strategy()
raise
def _local_check(self, check_strategy):
"""
Specific checks for local mode of FsBackupExecutor (same user)
:param CheckStrategy check_strategy: the strategy for the management
of the results of the various checks
"""
cmd = UnixLocalCommand(path=self.server.path)
pgdata = self.server.postgres.get_setting("data_directory")
# Check that PGDATA is accessible
check_strategy.init_check("local PGDATA")
hint = "Access to local PGDATA"
try:
cmd.check_directory_exists(pgdata)
except FsOperationFailed as e:
hint = force_str(e).strip()
# Output the result
check_strategy.result(self.config.name, cmd is not None, hint=hint)
def _remote_check(self, check_strategy):
"""
Specific checks for remote mode of FsBackupExecutor, via SSH.
:param CheckStrategy check_strategy: the strategy for the management
of the results of the various checks
"""
# Check the SSH connection
check_strategy.init_check("ssh")
hint = "PostgreSQL server"
cmd = None
minimal_ssh_output = None
try:
cmd = UnixRemoteCommand(
self.ssh_command, self.ssh_options, path=self.server.path
)
minimal_ssh_output = "".join(cmd.get_last_output())
except FsOperationFailed as e:
hint = force_str(e).strip()
# Output the result
check_strategy.result(self.config.name, cmd is not None, hint=hint)
# Check that the communication channel is "clean"
if minimal_ssh_output:
check_strategy.init_check("ssh output clean")
check_strategy.result(
self.config.name,
False,
hint="the configured ssh_command must not add anything to "
"the remote command output",
)
# If SSH works but PostgreSQL is not responding
server_txt_version = self.server.get_remote_status().get("server_txt_version")
if cmd is not None and server_txt_version is None:
# Check for 'backup_label' presence
last_backup = self.server.get_backup(
self.server.get_last_backup_id(BackupInfo.STATUS_NOT_EMPTY)
)
# Look for the latest backup in the catalogue
if last_backup:
check_strategy.init_check("backup_label")
# Get PGDATA and build path to 'backup_label'
backup_label = os.path.join(last_backup.pgdata, "backup_label")
# Verify that backup_label exists in the remote PGDATA.
# If so, send an alert. Do not show anything if OK.
exists = cmd.exists(backup_label)
if exists:
hint = (
"Check that the PostgreSQL server is up "
"and no 'backup_label' file is in PGDATA."
)
check_strategy.result(self.config.name, False, hint=hint)
def check(self, check_strategy):
"""
Perform additional checks for FsBackupExecutor, including
Ssh connection (executing a 'true' command on the remote server)
and specific checks for the given backup strategy.
:param CheckStrategy check_strategy: the strategy for the management
of the results of the various checks
"""
if self.local_mode:
# Perform checks for the local case
self._local_check(check_strategy)
else:
# Perform checks for the remote case
self._remote_check(check_strategy)
try:
# Invoke specific checks for the backup strategy
self.strategy.check(check_strategy)
except BaseException:
self._update_action_from_strategy()
raise
def status(self):
"""
Set additional status info for FsBackupExecutor using remote
commands via Ssh, as well as those defined by the given
backup strategy.
"""
try:
# Invoke the status() method for the given strategy
self.strategy.status()
except BaseException:
self._update_action_from_strategy()
raise
def fetch_remote_status(self):
"""
Get remote information on PostgreSQL using Ssh, such as
last archived WAL file
This method does not raise any exception in case of errors,
but set the missing values to None in the resulting dictionary.
:rtype: dict[str, None|str]
"""
remote_status = {}
# Retrieve the last archived WAL using a Ssh connection on
# the remote server and executing an 'ls' command. Only
# for pre-9.4 versions of PostgreSQL.
try:
if self.server.postgres and self.server.postgres.server_version < 90400:
remote_status["last_archived_wal"] = None
if self.server.postgres.get_setting(
"data_directory"
) and self.server.postgres.get_setting("archive_command"):
if not self.local_mode:
cmd = UnixRemoteCommand(
self.ssh_command, self.ssh_options, path=self.server.path
)
else:
cmd = UnixLocalCommand(path=self.server.path)
# Here the name of the PostgreSQL WALs directory is
# hardcoded, but that doesn't represent a problem as
# this code runs only for PostgreSQL < 9.4
archive_dir = os.path.join(
self.server.postgres.get_setting("data_directory"),
"pg_xlog",
"archive_status",
)
out = str(cmd.list_dir_content(archive_dir, ["-t"]))
for line in out.splitlines():
if line.endswith(".done"):
name = line[:-5]
if xlog.is_any_xlog_file(name):
remote_status["last_archived_wal"] = name
break
except (PostgresConnectionError, FsOperationFailed) as e:
_logger.warning("Error retrieving PostgreSQL status: %s", e)
return remote_status
def _start_backup_copy_message(self, backup_info):
number_of_workers = self.config.parallel_jobs
via = "rsync/SSH"
if self.local_mode:
via = "local rsync"
message = "Starting backup copy via %s for %s" % (
via,
backup_info.backup_id,
)
if number_of_workers > 1:
message += " (%s jobs)" % number_of_workers
output.info(message)
class PassiveBackupExecutor(BackupExecutor):
"""
Dummy backup executors for Passive servers.
Raises a SshCommandException if 'primary_ssh_command' is not set.
"""
def __init__(self, backup_manager):
"""
Constructor of Dummy backup executors for Passive servers.
:param barman.backup.BackupManager backup_manager: the BackupManager
assigned to the executor
"""
super(PassiveBackupExecutor, self).__init__(backup_manager)
# Retrieve the ssh command and the options necessary for the
# remote ssh access.
self.ssh_command, self.ssh_options = _parse_ssh_command(
backup_manager.config.primary_ssh_command
)
# Requires ssh_command to be set
if not self.ssh_command:
raise SshCommandException(
"Invalid primary_ssh_command in barman configuration "
"for server %s" % backup_manager.config.name
)
def backup(self, backup_info):
"""
This method should never be called, because this is a passive server
:param barman.infofile.LocalBackupInfo backup_info: backup information
"""
# The 'backup' command is not available on a passive node.
# If we get here, there is a programming error
assert False
def check(self, check_strategy):
"""
Perform additional checks for PassiveBackupExecutor, including
Ssh connection to the primary (executing a 'true' command on the
remote server).
:param CheckStrategy check_strategy: the strategy for the management
of the results of the various checks
"""
check_strategy.init_check("ssh")
hint = "Barman primary node"
cmd = None
minimal_ssh_output = None
try:
cmd = UnixRemoteCommand(
self.ssh_command, self.ssh_options, path=self.server.path
)
minimal_ssh_output = "".join(cmd.get_last_output())
except FsOperationFailed as e:
hint = force_str(e).strip()
# Output the result
check_strategy.result(self.config.name, cmd is not None, hint=hint)
# Check if the communication channel is "clean"
if minimal_ssh_output:
check_strategy.init_check("ssh output clean")
check_strategy.result(
self.config.name,
False,
hint="the configured ssh_command must not add anything to "
"the remote command output",
)
def status(self):
"""
Set additional status info for PassiveBackupExecutor.
"""
# On passive nodes show the primary_ssh_command
output.result(
"status",
self.config.name,
"primary_ssh_command",
"SSH command to primary server",
self.config.primary_ssh_command,
)
@property
def mode(self):
"""
Property that defines the mode used for the backup.
:return str: a string describing the mode used for the backup
"""
return "passive"
class RsyncBackupExecutor(FsBackupExecutor):
"""
Concrete class for backup via Rsync+Ssh.
It invokes PostgreSQL commands to start and stop the backup, depending
on the defined strategy. Data files are copied using Rsync via Ssh.
It heavily relies on methods defined in the FsBackupExecutor class
from which it derives.
"""
def __init__(self, backup_manager, local_mode=False):
"""
Constructor
:param barman.backup.BackupManager backup_manager: the BackupManager
assigned to the strategy
"""
super(RsyncBackupExecutor, self).__init__(backup_manager, "rsync", local_mode)
def backup_copy(self, backup_info):
"""
Perform the actual copy of the backup using Rsync.
First, it copies one tablespace at a time, then the PGDATA directory,
and finally configuration files (if outside PGDATA).
Bandwidth limitation, according to configuration, is applied in
the process.
This method is the core of base backup copy using Rsync+Ssh.
:param barman.infofile.LocalBackupInfo backup_info: backup information
"""
# Retrieve the previous backup metadata, then calculate safe_horizon
previous_backup = self.backup_manager.get_previous_backup(backup_info.backup_id)
safe_horizon = None
reuse_backup = None
# Store the start time
self.copy_start_time = datetime.datetime.now()
if previous_backup:
# safe_horizon is a tz-aware timestamp because BackupInfo class
# ensures that property
reuse_backup = self.config.reuse_backup
safe_horizon = previous_backup.begin_time
# Create the copy controller object, specific for rsync,
# which will drive all the copy operations. Items to be
# copied are added before executing the copy() method
controller = RsyncCopyController(
path=self.server.path,
ssh_command=self.ssh_command,
ssh_options=self.ssh_options,
network_compression=self.config.network_compression,
reuse_backup=reuse_backup,
safe_horizon=safe_horizon,
retry_times=self.config.basebackup_retry_times,
retry_sleep=self.config.basebackup_retry_sleep,
workers=self.config.parallel_jobs,
)
# List of paths to be excluded by the PGDATA copy
exclude_and_protect = []
# Process every tablespace
if backup_info.tablespaces:
for tablespace in backup_info.tablespaces:
# If the tablespace location is inside the data directory,
# exclude and protect it from being copied twice during
# the data directory copy
if tablespace.location.startswith(backup_info.pgdata + "/"):
exclude_and_protect += [
tablespace.location[len(backup_info.pgdata) :]
]
# Exclude and protect the tablespace from being copied again
# during the data directory copy
exclude_and_protect += ["/pg_tblspc/%s" % tablespace.oid]
# Make sure the destination directory exists in order for
# smart copy to detect that no file is present there
tablespace_dest = backup_info.get_data_directory(tablespace.oid)
mkpath(tablespace_dest)
# Add the tablespace directory to the list of objects
# to be copied by the controller.
# NOTE: Barman should archive only the content of directory
# "PG_" + PG_MAJORVERSION + "_" + CATALOG_VERSION_NO
# but CATALOG_VERSION_NO is not easy to retrieve, so we copy
# "PG_" + PG_MAJORVERSION + "_*"
# It could select some spurious directory if a development or
# a beta version have been used, but it's good enough for a
# production system as it filters out other major versions.
controller.add_directory(
label=tablespace.name,
src="%s/" % self._format_src(tablespace.location),
dst=tablespace_dest,
exclude=["/*"] + EXCLUDE_LIST,
include=["/PG_%s_*" % self.server.postgres.server_major_version],
bwlimit=self.config.get_bwlimit(tablespace),
reuse=self._reuse_path(previous_backup, tablespace),
item_class=controller.TABLESPACE_CLASS,
)
# Make sure the destination directory exists in order for smart copy
# to detect that no file is present there
backup_dest = backup_info.get_data_directory()
mkpath(backup_dest)
# Add the PGDATA directory to the list of objects to be copied
# by the controller
controller.add_directory(
label="pgdata",
src="%s/" % self._format_src(backup_info.pgdata),
dst=backup_dest,
exclude=PGDATA_EXCLUDE_LIST + EXCLUDE_LIST,
exclude_and_protect=exclude_and_protect,
bwlimit=self.config.get_bwlimit(),
reuse=self._reuse_path(previous_backup),
item_class=controller.PGDATA_CLASS,
)
# At last copy pg_control
controller.add_file(
label="pg_control",
src="%s/global/pg_control" % self._format_src(backup_info.pgdata),
dst="%s/global/pg_control" % (backup_dest,),
item_class=controller.PGCONTROL_CLASS,
)
# Copy configuration files (if not inside PGDATA)
external_config_files = backup_info.get_external_config_files()
included_config_files = []
for config_file in external_config_files:
# Add included files to a list, they will be handled later
if config_file.file_type == "include":
included_config_files.append(config_file)
continue
# If the ident file is missing, it isn't an error condition
# for PostgreSQL.
# Barman is consistent with this behavior.
optional = False
if config_file.file_type == "ident_file":
optional = True
# Create the actual copy jobs in the controller
controller.add_file(
label=config_file.file_type,
src=self._format_src(config_file.path),
dst=backup_dest,
optional=optional,
item_class=controller.CONFIG_CLASS,
)
# Execute the copy
try:
controller.copy()
# TODO: Improve the exception output
except CommandFailedException as e:
msg = "data transfer failure"
raise DataTransferFailure.from_command_error("rsync", e, msg)
# Store the end time
self.copy_end_time = datetime.datetime.now()
# Store statistics about the copy
backup_info.copy_stats = controller.statistics()
# Check for any include directives in PostgreSQL configuration
# Currently, include directives are not supported for files that
# reside outside PGDATA. These files must be manually backed up.
# Barman will emit a warning and list those files
if any(included_config_files):
msg = (
"The usage of include directives is not supported "
"for files that reside outside PGDATA.\n"
"Please manually backup the following files:\n"
"\t%s\n" % "\n\t".join(icf.path for icf in included_config_files)
)
# Show the warning only if the EXTERNAL_CONFIGURATION option
# is not specified in the backup_options.
if BackupOptions.EXTERNAL_CONFIGURATION not in self.config.backup_options:
output.warning(msg)
else:
_logger.debug(msg)
def _reuse_path(self, previous_backup_info, tablespace=None):
"""
If reuse_backup is 'copy' or 'link', builds the path of the directory
to reuse, otherwise always returns None.
If oid is None, it returns the full path of PGDATA directory of
the previous_backup otherwise it returns the path to the specified
tablespace using it's oid.
:param barman.infofile.LocalBackupInfo previous_backup_info: backup
to be reused
:param barman.infofile.Tablespace tablespace: the tablespace to copy
:returns: a string containing the local path with data to be reused
or None
:rtype: str|None
"""
oid = None
if tablespace:
oid = tablespace.oid
if (
self.config.reuse_backup in ("copy", "link")
and previous_backup_info is not None
):
try:
return previous_backup_info.get_data_directory(oid)
except ValueError:
return None
def _format_src(self, path):
"""
If the executor is operating in remote mode,
add a `:` in front of the path for rsync to work via SSH.
:param string path: the path to format
:return str: the formatted path string
"""
if not self.local_mode:
return ":%s" % path
return path
class BackupStrategy(with_metaclass(ABCMeta, object)):
"""
Abstract base class for a strategy to be used by a backup executor.
"""
#: Regex for START WAL LOCATION info
START_TIME_RE = re.compile(r"^START TIME: (.*)", re.MULTILINE)
#: Regex for START TIME info
WAL_RE = re.compile(r"^START WAL LOCATION: (.*) \(file (.*)\)", re.MULTILINE)
def __init__(self, postgres, server_name, mode=None):
"""
Constructor
:param barman.postgres.PostgreSQLConnection postgres: the PostgreSQL
connection
:param str server_name: The name of the server
"""
self.postgres = postgres
self.server_name = server_name
# Holds the action being executed. Used for error messages.
self.current_action = None
self.mode = mode
def start_backup(self, backup_info):
"""
Issue a start of a backup - invoked by BackupExecutor.backup()
:param barman.infofile.BackupInfo backup_info: backup information
"""
# Retrieve PostgreSQL server metadata
self._pg_get_metadata(backup_info)
# Record that we are about to start the backup
self.current_action = "issuing start backup command"
_logger.debug(self.current_action)
@abstractmethod
def stop_backup(self, backup_info):
"""
Issue a stop of a backup - invoked by BackupExecutor.backup()
:param barman.infofile.LocalBackupInfo backup_info: backup information
"""
@abstractmethod
def check(self, check_strategy):
"""
Perform additional checks - invoked by BackupExecutor.check()
:param CheckStrategy check_strategy: the strategy for the management
of the results of the various checks
"""
# noinspection PyMethodMayBeStatic
def status(self):
"""
Set additional status info - invoked by BackupExecutor.status()
"""
def _pg_get_metadata(self, backup_info):
"""
Load PostgreSQL metadata into the backup_info parameter
:param barman.infofile.BackupInfo backup_info: backup information
"""
# Get the PostgreSQL data directory location
self.current_action = "detecting data directory"
output.debug(self.current_action)
data_directory = self.postgres.get_setting("data_directory")
backup_info.set_attribute("pgdata", data_directory)
# Set server version
backup_info.set_attribute("version", self.postgres.server_version)
# Set XLOG segment size
backup_info.set_attribute("xlog_segment_size", self.postgres.xlog_segment_size)
# Set configuration files location
cf = self.postgres.get_configuration_files()
for key in cf:
backup_info.set_attribute(key, cf[key])
# Get tablespaces information
self.current_action = "detecting tablespaces"
output.debug(self.current_action)
tablespaces = self.postgres.get_tablespaces()
if tablespaces and len(tablespaces) > 0:
backup_info.set_attribute("tablespaces", tablespaces)
for item in tablespaces:
msg = "\t%s, %s, %s" % (item.oid, item.name, item.location)
_logger.info(msg)
@staticmethod
def _backup_info_from_start_location(backup_info, start_info):
"""
Fill a backup info with information from a start_backup
:param barman.infofile.BackupInfo backup_info: object
representing a
backup
:param DictCursor start_info: the result of the pg_start_backup
command
"""
backup_info.set_attribute("status", BackupInfo.STARTED)
backup_info.set_attribute("begin_time", start_info["timestamp"])
backup_info.set_attribute("begin_xlog", start_info["location"])
# PostgreSQL 9.6+ directly provides the timeline
if start_info.get("timeline") is not None:
backup_info.set_attribute("timeline", start_info["timeline"])
# Take a copy of stop_info because we are going to update it
start_info = start_info.copy()
start_info.update(
xlog.location_to_xlogfile_name_offset(
start_info["location"],
start_info["timeline"],
backup_info.xlog_segment_size,
)
)
# If file_name and file_offset are available, use them
file_name = start_info.get("file_name")
file_offset = start_info.get("file_offset")
if file_name is not None and file_offset is not None:
backup_info.set_attribute("begin_wal", start_info["file_name"])
backup_info.set_attribute("begin_offset", start_info["file_offset"])
# If the timeline is still missing, extract it from the file_name
if backup_info.timeline is None:
backup_info.set_attribute(
"timeline", int(start_info["file_name"][0:8], 16)
)
@staticmethod
def _backup_info_from_stop_location(backup_info, stop_info):
"""
Fill a backup info with information from a backup stop location
:param barman.infofile.BackupInfo backup_info: object representing a
backup
:param DictCursor stop_info: location info of stop backup
"""
# If file_name or file_offset are missing build them using the stop
# location and the timeline.
file_name = stop_info.get("file_name")
file_offset = stop_info.get("file_offset")
if file_name is None or file_offset is None:
# Take a copy of stop_info because we are going to update it
stop_info = stop_info.copy()
# Get the timeline from the stop_info if available, otherwise
# Use the one from the backup_label
timeline = stop_info.get("timeline")
if timeline is None:
timeline = backup_info.timeline
stop_info.update(
xlog.location_to_xlogfile_name_offset(
stop_info["location"], timeline, backup_info.xlog_segment_size
)
)
backup_info.set_attribute("end_time", stop_info["timestamp"])
backup_info.set_attribute("end_xlog", stop_info["location"])
backup_info.set_attribute("end_wal", stop_info["file_name"])
backup_info.set_attribute("end_offset", stop_info["file_offset"])
def _backup_info_from_backup_label(self, backup_info):
"""
Fill a backup info with information from the backup_label file
:param barman.infofile.BackupInfo backup_info: object
representing a backup
"""
# The backup_label must be already loaded
assert backup_info.backup_label
# Parse backup label
wal_info = self.WAL_RE.search(backup_info.backup_label)
start_time = self.START_TIME_RE.search(backup_info.backup_label)
if wal_info is None or start_time is None:
raise ValueError(
"Failure parsing backup_label for backup %s" % backup_info.backup_id
)
# Set data in backup_info from backup_label
backup_info.set_attribute("timeline", int(wal_info.group(2)[0:8], 16))
backup_info.set_attribute("begin_xlog", wal_info.group(1))
backup_info.set_attribute("begin_wal", wal_info.group(2))
backup_info.set_attribute(
"begin_offset",
xlog.parse_lsn(wal_info.group(1)) % backup_info.xlog_segment_size,
)
# If we have already obtained a begin_time then it takes precedence over the
# begin time in the backup label
if not backup_info.begin_time:
backup_info.set_attribute(
"begin_time", dateutil.parser.parse(start_time.group(1))
)
def _read_backup_label(self, backup_info):
"""
Read the backup_label file
:param barman.infofile.LocalBackupInfo backup_info: backup information
"""
self.current_action = "reading the backup label"
label_path = os.path.join(backup_info.get_data_directory(), "backup_label")
output.debug("Reading backup label: %s" % label_path)
with open(label_path, "r") as f:
backup_info.set_attribute("backup_label", f.read())
class PostgresBackupStrategy(BackupStrategy):
"""
Concrete class for postgres backup strategy.
This strategy is for PostgresBackupExecutor only and is responsible for
executing pre e post backup operations during a physical backup executed
using pg_basebackup.
"""
def check(self, check_strategy):
"""
Perform additional checks for the Postgres backup strategy
"""
def start_backup(self, backup_info):
"""
Manage the start of an pg_basebackup backup
The method performs all the preliminary operations required for a
backup executed using pg_basebackup to start, gathering information
from postgres and filling the backup_info.
:param barman.infofile.LocalBackupInfo backup_info: backup information
"""
self.current_action = "initialising postgres backup_method"
super(PostgresBackupStrategy, self).start_backup(backup_info)
current_xlog_info = self.postgres.current_xlog_info
self._backup_info_from_start_location(backup_info, current_xlog_info)
def stop_backup(self, backup_info):
"""
Manage the stop of an pg_basebackup backup
The method retrieves the information necessary for the
backup.info file reading the backup_label file.
Due of the nature of the pg_basebackup, information that are gathered
during the start of a backup performed using rsync, are retrieved
here
:param barman.infofile.LocalBackupInfo backup_info: backup information
"""
self._read_backup_label(backup_info)
self._backup_info_from_backup_label(backup_info)
# Set data in backup_info from current_xlog_info
self.current_action = "stopping postgres backup_method"
output.info("Finalising the backup.")
# Get the current xlog position
current_xlog_info = self.postgres.current_xlog_info
if current_xlog_info:
self._backup_info_from_stop_location(backup_info, current_xlog_info)
# Ask PostgreSQL to switch to another WAL file. This is needed
# to archive the transaction log file containing the backup
# end position, which is required to recover from the backup.
try:
self.postgres.switch_wal()
except PostgresIsInRecovery:
# Skip switching XLOG if a standby server
pass
class ExclusiveBackupStrategy(BackupStrategy):
"""
Concrete class for exclusive backup strategy.
This strategy is for FsBackupExecutor only and is responsible for
coordinating Barman with PostgreSQL on standard physical backup
operations (known as 'exclusive' backup), such as invoking
pg_start_backup() and pg_stop_backup() on the master server.
"""
def __init__(self, postgres, server_name):
"""
Constructor
:param barman.postgres.PostgreSQLConnection postgres: the PostgreSQL
connection
:param str server_name: The name of the server
"""
super(ExclusiveBackupStrategy, self).__init__(
postgres, server_name, "exclusive"
)
def start_backup(self, backup_info):
"""
Manage the start of an exclusive backup
The method performs all the preliminary operations required for an
exclusive physical backup to start, as well as preparing the
information on the backup for Barman.
:param barman.infofile.LocalBackupInfo backup_info: backup information
"""
super(ExclusiveBackupStrategy, self).start_backup(backup_info)
label = "Barman backup %s %s" % (backup_info.server_name, backup_info.backup_id)
# Issue an exclusive start backup command
_logger.debug("Start of exclusive backup")
start_info = self.postgres.start_exclusive_backup(label)
self._backup_info_from_start_location(backup_info, start_info)
def stop_backup(self, backup_info):
"""
Manage the stop of an exclusive backup
The method informs the PostgreSQL server that the physical
exclusive backup is finished, as well as preparing the information
returned by PostgreSQL for Barman.
:param barman.infofile.LocalBackupInfo backup_info: backup information
"""
self.current_action = "issuing stop backup command"
_logger.debug("Stop of exclusive backup")
stop_info = self.postgres.stop_exclusive_backup()
self._backup_info_from_stop_location(backup_info, stop_info)
def check(self, check_strategy):
"""
Perform additional checks for ExclusiveBackupStrategy
:param CheckStrategy check_strategy: the strategy for the management
of the results of the various checks
"""
# Make sure PostgreSQL is not in recovery (i.e. is a master)
check_strategy.init_check("not in recovery")
if self.postgres:
is_in_recovery = self.postgres.is_in_recovery
if not is_in_recovery:
check_strategy.result(self.server_name, True)
else:
check_strategy.result(
self.server_name,
False,
hint="cannot perform exclusive backup on a standby",
)
class ConcurrentBackupStrategy(BackupStrategy):
"""
Concrete class for concurrent backup strategy.
This strategy is responsible for coordinating Barman with PostgreSQL on
concurrent physical backup operations through concurrent backup
PostgreSQL api or the pgespresso extension.
"""
def __init__(self, postgres, server_name):
"""
Constructor
:param barman.postgres.PostgreSQLConnection postgres: the PostgreSQL
connection
:param str server_name: The name of the server
"""
super(ConcurrentBackupStrategy, self).__init__(
postgres, server_name, "concurrent"
)
def check(self, check_strategy):
"""
Perform additional checks for ConcurrentBackupStrategy
:param CheckStrategy check_strategy: the strategy for the management
of the results of the various checks
"""
check_strategy.init_check("pgespresso extension")
try:
# We execute this check only if the postgres connection is non None
# and the server version is lower than 9.6. On latest PostgreSQL
# there is a native API for concurrent backups.
if self.postgres and self.postgres.server_version < 90600:
if self.postgres.has_pgespresso:
check_strategy.result(self.server_name, True)
else:
check_strategy.result(
self.server_name,
False,
hint="required for concurrent "
"backups on PostgreSQL %s" % self.postgres.server_major_version,
)
except PostgresConnectionError:
# Skip the check if the postgres connection doesn't work.
# We assume that this error condition will be reported by
# another check.
pass
def start_backup(self, backup_info):
"""
Start of the backup.
The method performs all the preliminary operations required for a
backup to start.
:param barman.infofile.BackupInfo backup_info: backup information
"""
super(ConcurrentBackupStrategy, self).start_backup(backup_info)
label = "Barman backup %s %s" % (backup_info.server_name, backup_info.backup_id)
pg_version = self.postgres.server_version
if pg_version >= 90600:
# On 9.6+ execute native concurrent start backup
_logger.debug("Start of native concurrent backup")
self._concurrent_start_backup(backup_info, label)
else:
# On older Postgres use pgespresso
_logger.debug("Start of concurrent backup with pgespresso")
self._pgespresso_start_backup(backup_info, label)
def stop_backup(self, backup_info):
"""
Stop backup wrapper
:param barman.infofile.BackupInfo backup_info: backup information
"""
pg_version = self.postgres.server_version
self.current_action = "issuing stop backup command"
if pg_version >= 90600:
# On 9.6+ execute native concurrent stop backup
self.current_action += " (native concurrent)"
_logger.debug("Stop of native concurrent backup")
self._concurrent_stop_backup(backup_info)
else:
# On older Postgres use pgespresso
self.current_action += " (pgespresso)"
_logger.debug("Stop of concurrent backup with pgespresso")
self._pgespresso_stop_backup(backup_info)
# Write backup_label retrieved from postgres connection
self.current_action = "writing backup label"
# Ask PostgreSQL to switch to another WAL file. This is needed
# to archive the transaction log file containing the backup
# end position, which is required to recover from the backup.
try:
self.postgres.switch_wal()
except PostgresIsInRecovery:
# Skip switching XLOG if a standby server
pass
def _pgespresso_start_backup(self, backup_info, label):
"""
Start a concurrent backup using pgespresso
:param barman.infofile.BackupInfo backup_info: backup information
"""
backup_info.set_attribute("status", BackupInfo.STARTED)
start_info = self.postgres.pgespresso_start_backup(label)
backup_info.set_attribute("backup_label", start_info["backup_label"])
self._backup_info_from_backup_label(backup_info)
def _pgespresso_stop_backup(self, backup_info):
"""
Stop a concurrent backup using pgespresso
:param barman.infofile.BackupInfo backup_info: backup information
"""
stop_info = self.postgres.pgespresso_stop_backup(backup_info.backup_label)
# Obtain a modifiable copy of stop_info object
stop_info = stop_info.copy()
# We don't know the exact backup stop location,
# so we include the whole segment.
stop_info["location"] = xlog.location_from_xlogfile_name_offset(
stop_info["end_wal"],
self.postgres.xlog_segment_size - 1,
self.postgres.xlog_segment_size,
)
self._backup_info_from_stop_location(backup_info, stop_info)
def _concurrent_start_backup(self, backup_info, label):
"""
Start a concurrent backup using the PostgreSQL 9.6
concurrent backup api
:param barman.infofile.BackupInfo backup_info: backup information
:param str label: the backup label
"""
start_info = self.postgres.start_concurrent_backup(label)
self.postgres.allow_reconnect = False
self._backup_info_from_start_location(backup_info, start_info)
def _concurrent_stop_backup(self, backup_info):
"""
Stop a concurrent backup using the PostgreSQL 9.6
concurrent backup api
:param barman.infofile.BackupInfo backup_info: backup information
"""
stop_info = self.postgres.stop_concurrent_backup()
self.postgres.allow_reconnect = True
backup_info.set_attribute("backup_label", stop_info["backup_label"])
self._backup_info_from_stop_location(backup_info, stop_info)
class LocalConcurrentBackupStrategy(ConcurrentBackupStrategy):
"""
Concrete class for concurrent backup strategy writing data locally.
This strategy is for FsBackupExecutor only and is responsible for
coordinating Barman with PostgreSQL on concurrent physical backup
operations through the pgespresso extension.
"""
# noinspection PyMethodMayBeStatic
def _write_backup_label(self, backup_info):
"""
Write the backup_label file inside local data directory
:param barman.infofile.LocalBackupInfo backup_info: backup information
"""
label_file = os.path.join(backup_info.get_data_directory(), "backup_label")
output.debug("Writing backup label: %s" % label_file)
with open(label_file, "w") as f:
f.write(backup_info.backup_label)
def stop_backup(self, backup_info):
"""
Stop backup wrapper
:param barman.infofile.LocalBackupInfo backup_info: backup information
"""
super(LocalConcurrentBackupStrategy, self).stop_backup(backup_info)
self._write_backup_label(backup_info)
barman-2.18/barman/xlog.py 0000644 0006212 0006212 00000040034 14172556763 013664 0 ustar 0000000 0000000 # -*- coding: utf-8 -*-
# © Copyright EnterpriseDB UK Limited 2011-2022
#
# This file is part of Barman.
#
# Barman is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Barman is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Barman. If not, see .
"""
This module contains functions to retrieve information about xlog
files
"""
import collections
import os
import re
from functools import partial
from tempfile import NamedTemporaryFile
from barman.exceptions import (
BadHistoryFileContents,
BadXlogSegmentName,
CommandException,
WalArchiveContentError,
)
# xlog file segment name parser (regular expression)
_xlog_re = re.compile(
r"""
^
([\dA-Fa-f]{8}) # everything has a timeline
(?:
([\dA-Fa-f]{8})([\dA-Fa-f]{8}) # segment name, if a wal file
(?: # and optional
\.[\dA-Fa-f]{8}\.backup # offset, if a backup label
|
\.partial # partial, if a partial file
)?
|
\.history # or only .history, if a history file
)
$
""",
re.VERBOSE,
)
# xlog location parser for concurrent backup (regular expression)
_location_re = re.compile(r"^([\dA-F]+)/([\dA-F]+)$")
# Taken from xlog_internal.h from PostgreSQL sources
#: XLOG_SEG_SIZE is the size of a single WAL file. This must be a power of 2
#: and larger than XLOG_BLCKSZ (preferably, a great deal larger than
#: XLOG_BLCKSZ).
DEFAULT_XLOG_SEG_SIZE = 1 << 24
#: This namedtuple is a container for the information
#: contained inside history files
HistoryFileData = collections.namedtuple(
"HistoryFileData", "tli parent_tli switchpoint reason"
)
def is_any_xlog_file(path):
"""
Return True if the xlog is either a WAL segment, a .backup file
or a .history file, False otherwise.
It supports either a full file path or a simple file name.
:param str path: the file name to test
:rtype: bool
"""
match = _xlog_re.match(os.path.basename(path))
if match:
return True
return False
def is_history_file(path):
"""
Return True if the xlog is a .history file, False otherwise
It supports either a full file path or a simple file name.
:param str path: the file name to test
:rtype: bool
"""
match = _xlog_re.search(os.path.basename(path))
if match and match.group(0).endswith(".history"):
return True
return False
def is_backup_file(path):
"""
Return True if the xlog is a .backup file, False otherwise
It supports either a full file path or a simple file name.
:param str path: the file name to test
:rtype: bool
"""
match = _xlog_re.search(os.path.basename(path))
if match and match.group(0).endswith(".backup"):
return True
return False
def is_partial_file(path):
"""
Return True if the xlog is a .partial file, False otherwise
It supports either a full file path or a simple file name.
:param str path: the file name to test
:rtype: bool
"""
match = _xlog_re.search(os.path.basename(path))
if match and match.group(0).endswith(".partial"):
return True
return False
def is_wal_file(path):
"""
Return True if the xlog is a regular xlog file, False otherwise
It supports either a full file path or a simple file name.
:param str path: the file name to test
:rtype: bool
"""
match = _xlog_re.search(os.path.basename(path))
if not match:
return False
ends_with_backup = match.group(0).endswith(".backup")
ends_with_history = match.group(0).endswith(".history")
ends_with_partial = match.group(0).endswith(".partial")
if ends_with_backup:
return False
if ends_with_history:
return False
if ends_with_partial:
return False
return True
def decode_segment_name(path):
"""
Retrieve the timeline, log ID and segment ID
from the name of a xlog segment
It can handle either a full file path or a simple file name.
:param str path: the file name to decode
:rtype: list[int]
"""
name = os.path.basename(path)
match = _xlog_re.match(name)
if not match:
raise BadXlogSegmentName(name)
return [int(x, 16) if x else None for x in match.groups()]
def encode_segment_name(tli, log, seg):
"""
Build the xlog segment name based on timeline, log ID and segment ID
:param int tli: timeline number
:param int log: log number
:param int seg: segment number
:return str: segment file name
"""
return "%08X%08X%08X" % (tli, log, seg)
def encode_history_file_name(tli):
"""
Build the history file name based on timeline
:return str: history file name
"""
return "%08X.history" % (tli,)
def xlog_segments_per_file(xlog_segment_size):
"""
Given that WAL files are named using the following pattern:
this is the number of XLOG segments in an XLOG file. By XLOG file
we don't mean an actual file on the filesystem, but the definition
used in the PostgreSQL sources: meaning a set of files containing the
same file number.
:param int xlog_segment_size: The XLOG segment size in bytes
:return int: The number of segments in an XLOG file
"""
return 0xFFFFFFFF // xlog_segment_size
def xlog_segment_mask(xlog_segment_size):
"""
Given that WAL files are named using the following pattern:
this is the bitmask of segment part of an XLOG file.
See the documentation of `xlog_segments_per_file` for a
commentary on the definition of `XLOG` file.
:param int xlog_segment_size: The XLOG segment size in bytes
:return int: The size of an XLOG file
"""
return xlog_segment_size * xlog_segments_per_file(xlog_segment_size)
def generate_segment_names(begin, end=None, version=None, xlog_segment_size=None):
"""
Generate a sequence of XLOG segments starting from ``begin``
If an ``end`` segment is provided the sequence will terminate after
returning it, otherwise the sequence will never terminate.
If the XLOG segment size is known, this generator is precise,
switching to the next file when required.
It the XLOG segment size is unknown, this generator will generate
all the possible XLOG file names.
The size of an XLOG segment can be every power of 2 between
the XLOG block size (8Kib) and the size of a log segment (4Gib)
:param str begin: begin segment name
:param str|None end: optional end segment name
:param int|None version: optional postgres version as an integer
(e.g. 90301 for 9.3.1)
:param int xlog_segment_size: the size of a XLOG segment
:rtype: collections.Iterable[str]
:raise: BadXlogSegmentName
"""
begin_tli, begin_log, begin_seg = decode_segment_name(begin)
end_tli, end_log, end_seg = None, None, None
if end:
end_tli, end_log, end_seg = decode_segment_name(end)
# this method doesn't support timeline changes
assert begin_tli == end_tli, (
"Begin segment (%s) and end segment (%s) "
"must have the same timeline part" % (begin, end)
)
# If version is less than 9.3 the last segment must be skipped
skip_last_segment = version is not None and version < 90300
# This is the number of XLOG segments in an XLOG file. By XLOG file
# we don't mean an actual file on the filesystem, but the definition
# used in the PostgreSQL sources: a set of files containing the
# same file number.
if xlog_segment_size:
# The generator is operating is precise and correct mode:
# knowing exactly when a switch to the next file is required
xlog_seg_per_file = xlog_segments_per_file(xlog_segment_size)
else:
# The generator is operating only in precise mode: generating every
# possible XLOG file name.
xlog_seg_per_file = 0x7FFFF
# Start from the first xlog and generate the segments sequentially
# If ``end`` has been provided, the while condition ensure the termination
# otherwise this generator will never stop
cur_log, cur_seg = begin_log, begin_seg
while (
end is None or cur_log < end_log or (cur_log == end_log and cur_seg <= end_seg)
):
yield encode_segment_name(begin_tli, cur_log, cur_seg)
cur_seg += 1
if cur_seg > xlog_seg_per_file or (
skip_last_segment and cur_seg == xlog_seg_per_file
):
cur_seg = 0
cur_log += 1
def hash_dir(path):
"""
Get the directory where the xlog segment will be stored
It can handle either a full file path or a simple file name.
:param str|unicode path: xlog file name
:return str: directory name
"""
tli, log, _ = decode_segment_name(path)
# tli is always not None
if log is not None:
return "%08X%08X" % (tli, log)
else:
return ""
def parse_lsn(lsn_string):
"""
Transform a string XLOG location, formatted as %X/%X, in the corresponding
numeric representation
:param str lsn_string: the string XLOG location, i.e. '2/82000168'
:rtype: int
"""
lsn_list = lsn_string.split("/")
if len(lsn_list) != 2:
raise ValueError("Invalid LSN: %s", lsn_string)
return (int(lsn_list[0], 16) << 32) + int(lsn_list[1], 16)
def diff_lsn(lsn_string1, lsn_string2):
"""
Calculate the difference in bytes between two string XLOG location,
formatted as %X/%X
Tis function is a Python implementation of
the ``pg_xlog_location_diff(str, str)`` PostgreSQL function.
:param str lsn_string1: the string XLOG location, i.e. '2/82000168'
:param str lsn_string2: the string XLOG location, i.e. '2/82000168'
:rtype: int
"""
# If one the input is None returns None
if lsn_string1 is None or lsn_string2 is None:
return None
return parse_lsn(lsn_string1) - parse_lsn(lsn_string2)
def format_lsn(lsn):
"""
Transform a numeric XLOG location, in the corresponding %X/%X string
representation
:param int lsn: numeric XLOG location
:rtype: str
"""
return "%X/%X" % (lsn >> 32, lsn & 0xFFFFFFFF)
def location_to_xlogfile_name_offset(location, timeline, xlog_segment_size):
"""
Convert transaction log location string to file_name and file_offset
This is a reimplementation of pg_xlogfile_name_offset PostgreSQL function
This method returns a dictionary containing the following data:
* file_name
* file_offset
:param str location: XLOG location
:param int timeline: timeline
:param int xlog_segment_size: the size of a XLOG segment
:rtype: dict
"""
lsn = parse_lsn(location)
log = lsn >> 32
seg = (lsn & xlog_segment_mask(xlog_segment_size)) // xlog_segment_size
offset = lsn & (xlog_segment_size - 1)
return {
"file_name": encode_segment_name(timeline, log, seg),
"file_offset": offset,
}
def location_from_xlogfile_name_offset(file_name, file_offset, xlog_segment_size):
"""
Convert file_name and file_offset to a transaction log location.
This is the inverted function of PostgreSQL's pg_xlogfile_name_offset
function.
:param str file_name: a WAL file name
:param int file_offset: a numeric offset
:param int xlog_segment_size: the size of a XLOG segment
:rtype: str
"""
decoded_segment = decode_segment_name(file_name)
location = decoded_segment[1] << 32
location += decoded_segment[2] * xlog_segment_size
location += file_offset
return format_lsn(location)
def decode_history_file(wal_info, comp_manager):
"""
Read an history file and parse its contents.
Each line in the file represents a timeline switch, each field is
separated by tab, empty lines are ignored and lines starting with '#'
are comments.
Each line is composed by three fields: parentTLI, switchpoint and reason.
"parentTLI" is the ID of the parent timeline.
"switchpoint" is the WAL position where the switch happened
"reason" is an human-readable explanation of why the timeline was changed
The method requires a CompressionManager object to handle the eventual
compression of the history file.
:param barman.infofile.WalFileInfo wal_info: history file obj
:param comp_manager: compression manager used in case
of history file compression
:return List[HistoryFileData]: information from the history file
"""
path = wal_info.orig_filename
# Decompress the file if needed
if wal_info.compression:
# Use a NamedTemporaryFile to avoid explicit cleanup
uncompressed_file = NamedTemporaryFile(
dir=os.path.dirname(path),
prefix=".%s." % wal_info.name,
suffix=".uncompressed",
)
path = uncompressed_file.name
comp_manager.get_compressor(wal_info.compression).decompress(
wal_info.orig_filename, path
)
# Extract the timeline from history file name
tli, _, _ = decode_segment_name(wal_info.name)
lines = []
with open(path) as fp:
for line in fp:
line = line.strip()
# Skip comments and empty lines
if line.startswith("#"):
continue
# Skip comments and empty lines
if len(line) == 0:
continue
# Use tab as separator
contents = line.split("\t")
if len(contents) != 3:
# Invalid content of the line
raise BadHistoryFileContents(path)
history = HistoryFileData(
tli=tli,
parent_tli=int(contents[0]),
switchpoint=parse_lsn(contents[1]),
reason=contents[2],
)
lines.append(history)
# Empty history file or containing invalid content
if len(lines) == 0:
raise BadHistoryFileContents(path)
else:
return lines
def _validate_timeline(timeline):
"""Check that timeline is a valid timeline value."""
try:
# Explicitly check the type becauase python 2 will allow < to be used
# between strings and ints
if type(timeline) is not int or timeline < 1:
raise ValueError()
return True
except Exception:
raise CommandException(
"Cannot check WAL archive with malformed timeline %s" % timeline
)
def _wal_archive_filter_fun(timeline, wal):
try:
if not is_any_xlog_file(wal):
raise ValueError()
except Exception:
raise WalArchiveContentError("Unexpected file %s found in WAL archive" % wal)
wal_timeline, _, _ = decode_segment_name(wal)
return timeline <= wal_timeline
def check_archive_usable(existing_wals, timeline=None):
"""
Carry out pre-flight checks on the existing content of a WAL archive to
determine if it is safe to archive WALs from the supplied timeline.
"""
if timeline is None:
if len(existing_wals) > 0:
raise WalArchiveContentError("Expected empty archive")
else:
_validate_timeline(timeline)
filter_fun = partial(_wal_archive_filter_fun, timeline)
unexpected_wals = [wal for wal in existing_wals if filter_fun(wal)]
num_unexpected_wals = len(unexpected_wals)
if num_unexpected_wals > 0:
raise WalArchiveContentError(
"Found %s file%s in WAL archive equal to or newer than "
"timeline %s"
% (
num_unexpected_wals,
num_unexpected_wals > 1 and "s" or "",
timeline,
)
)
barman-2.18/barman/compression.py 0000644 0006212 0006212 00000031105 14172556763 015253 0 ustar 0000000 0000000 # -*- coding: utf-8 -*-
# © Copyright EnterpriseDB UK Limited 2011-2022
#
# This file is part of Barman.
#
# Barman is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Barman is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Barman. If not, see .
"""
This module is responsible to manage the compression features of Barman
"""
import binascii
import bz2
import gzip
import logging
import shutil
import sys
from abc import ABCMeta, abstractmethod
from contextlib import closing
import barman.infofile
from barman.command_wrappers import Command
from barman.exceptions import CommandFailedException, CompressionIncompatibility
from barman.utils import force_str, with_metaclass
_logger = logging.getLogger(__name__)
class CompressionManager(object):
def __init__(self, config, path):
"""
Compression manager
"""
self.config = config
self.path = path
self.unidentified_compression = None
# If Barman is set to use the custom compression, it assumes that
# every unidentified file is custom compressed
if self.config.compression == "custom":
self.unidentified_compression = self.config.compression
def check(self, compression=None):
"""
This method returns True if the compression specified in the
configuration file is present in the register, otherwise False
"""
if not compression:
compression = self.config.compression
if compression not in compression_registry:
return False
return True
def get_default_compressor(self):
"""
Returns a new default compressor instance
"""
return self.get_compressor(self.config.compression)
def get_compressor(self, compression):
"""
Returns a new compressor instance
:param str compression: Compression name or none
"""
# Check if the requested compression mechanism is allowed
if compression and self.check(compression):
return compression_registry[compression](
config=self.config, compression=compression, path=self.path
)
return None
def get_wal_file_info(self, filename):
"""
Populate a WalFileInfo object taking into account the server
configuration.
Set compression to 'custom' if no compression is identified
and Barman is configured to use custom compression.
:param str filename: the path of the file to identify
:rtype: barman.infofile.WalFileInfo
"""
return barman.infofile.WalFileInfo.from_file(
filename,
compression_manager=self,
unidentified_compression=self.unidentified_compression,
)
def identify_compression(self, filename):
"""
Try to guess the compression algorithm of a file
:param str filename: the path of the file to identify
:rtype: str
"""
# TODO: manage multiple decompression methods for the same
# compression algorithm (e.g. what to do when gzip is detected?
# should we use gzip or pigz?)
with open(filename, "rb") as f:
file_start = f.read(MAGIC_MAX_LENGTH)
for file_type, cls in sorted(compression_registry.items()):
if file_type == "custom":
try:
compressor = self.get_compressor(file_type)
if compressor.validate(file_start):
return file_type
except CompressionIncompatibility:
# ignore exceptions that might happen when creating
# a custom compressor
pass
elif cls.validate(file_start):
return file_type
return None
class Compressor(with_metaclass(ABCMeta, object)):
"""
Base class for all the compressors
"""
MAGIC = None
def __init__(self, config, compression, path=None):
self.config = config
self.compression = compression
self.path = path
@classmethod
def validate(cls, file_start):
"""
Guess if the first bytes of a file are compatible with the compression
implemented by this class
:param file_start: a binary string representing the first few
bytes of a file
:rtype: bool
"""
return cls.MAGIC and file_start.startswith(cls.MAGIC)
@abstractmethod
def compress(self, src, dst):
"""
Abstract Method for compression method
:param str src: source file path
:param str dst: destination file path
"""
@abstractmethod
def decompress(self, src, dst):
"""
Abstract method for decompression method
:param str src: source file path
:param str dst: destination file path
"""
class CommandCompressor(Compressor):
"""
Base class for compressors built on external commands
"""
def __init__(self, config, compression, path=None):
super(CommandCompressor, self).__init__(config, compression, path)
self._compress = None
self._decompress = None
def compress(self, src, dst):
"""
Compress using the specific command defined in the sublcass
:param src: source file to compress
:param dst: destination of the decompression
"""
return self._compress(src, dst)
def decompress(self, src, dst):
"""
Decompress using the specific command defined in the sublcass
:param src: source file to decompress
:param dst: destination of the decompression
"""
return self._decompress(src, dst)
def _build_command(self, pipe_command):
"""
Build the command string and create the actual Command object
:param pipe_command: the command used to compress/decompress
:rtype: Command
"""
command = "barman_command(){ "
command += pipe_command
command += ' > "$2" < "$1"'
command += ";}; barman_command"
return Command(command, shell=True, check=True, path=self.path)
class InternalCompressor(Compressor):
"""
Base class for compressors built on python libraries
"""
def compress(self, src, dst):
"""
Compress using the object defined in the sublcass
:param src: source file to compress
:param dst: destination of the decompression
"""
try:
with open(src, "rb") as istream:
with closing(self._compressor(dst)) as ostream:
shutil.copyfileobj(istream, ostream)
except Exception as e:
# you won't get more information from the compressors anyway
raise CommandFailedException(dict(ret=None, err=force_str(e), out=None))
return 0
def decompress(self, src, dst):
"""
Decompress using the object defined in the sublcass
:param src: source file to decompress
:param dst: destination of the decompression
"""
try:
with closing(self._decompressor(src)) as istream:
with open(dst, "wb") as ostream:
shutil.copyfileobj(istream, ostream)
except Exception as e:
# you won't get more information from the compressors anyway
raise CommandFailedException(dict(ret=None, err=force_str(e), out=None))
return 0
@abstractmethod
def _decompressor(self, src):
"""
Abstract decompressor factory method
:param src: source file path
:return: a file-like readable decompressor object
"""
@abstractmethod
def _compressor(self, dst):
"""
Abstract compressor factory method
:param dst: destination file path
:return: a file-like writable compressor object
"""
class GZipCompressor(CommandCompressor):
"""
Predefined compressor with GZip
"""
MAGIC = b"\x1f\x8b\x08"
def __init__(self, config, compression, path=None):
super(GZipCompressor, self).__init__(config, compression, path)
self._compress = self._build_command("gzip -c")
self._decompress = self._build_command("gzip -c -d")
class PyGZipCompressor(InternalCompressor):
"""
Predefined compressor that uses GZip Python libraries
"""
MAGIC = b"\x1f\x8b\x08"
def __init__(self, config, compression, path=None):
super(PyGZipCompressor, self).__init__(config, compression, path)
# Default compression level used in system gzip utility
self._level = -1 # Z_DEFAULT_COMPRESSION constant of zlib
def _compressor(self, name):
return gzip.GzipFile(name, mode="wb", compresslevel=self._level)
def _decompressor(self, name):
return gzip.GzipFile(name, mode="rb")
class PigzCompressor(CommandCompressor):
"""
Predefined compressor with Pigz
Note that pigz on-disk is the same as gzip, so the MAGIC value of this
class is the same
"""
MAGIC = b"\x1f\x8b\x08"
def __init__(self, config, compression, path=None):
super(PigzCompressor, self).__init__(config, compression, path)
self._compress = self._build_command("pigz -c")
self._decompress = self._build_command("pigz -c -d")
class BZip2Compressor(CommandCompressor):
"""
Predefined compressor with BZip2
"""
MAGIC = b"\x42\x5a\x68"
def __init__(self, config, compression, path=None):
super(BZip2Compressor, self).__init__(config, compression, path)
self._compress = self._build_command("bzip2 -c")
self._decompress = self._build_command("bzip2 -c -d")
class PyBZip2Compressor(InternalCompressor):
"""
Predefined compressor with BZip2 Python libraries
"""
MAGIC = b"\x42\x5a\x68"
def __init__(self, config, compression, path=None):
super(PyBZip2Compressor, self).__init__(config, compression, path)
# Default compression level used in system gzip utility
self._level = 9
def _compressor(self, name):
return bz2.BZ2File(name, mode="wb", compresslevel=self._level)
def _decompressor(self, name):
return bz2.BZ2File(name, mode="rb")
class CustomCompressor(CommandCompressor):
"""
Custom compressor
"""
def __init__(self, config, compression, path=None):
if (
config.custom_compression_filter is None
or type(config.custom_compression_filter) != str
):
raise CompressionIncompatibility("custom_compression_filter")
if (
config.custom_decompression_filter is None
or type(config.custom_decompression_filter) != str
):
raise CompressionIncompatibility("custom_decompression_filter")
if type(config.custom_compression_magic) == str:
self.MAGIC = binascii.unhexlify(config.custom_compression_magic[2:])
# increase the MAGIC_MAX_LENGTH
sys.modules[__name__].MAGIC_MAX_LENGTH = max(
MAGIC_MAX_LENGTH, len(self.MAGIC)
)
super(CustomCompressor, self).__init__(config, compression, path)
self._compress = self._build_command(config.custom_compression_filter)
self._decompress = self._build_command(config.custom_decompression_filter)
def validate(self, file_start):
"""
An instance version of the validate class method.
This is needed because it is not possible to determine what the first bytes
should be for a custom compressor until the compressor object is created.
"""
return self.MAGIC and file_start.startswith(self.MAGIC)
# a dictionary mapping all supported compression schema
# to the class implementing it
# WARNING: items in this dictionary are extracted using alphabetical order
# It's important that gzip and bzip2 are positioned before their variants
compression_registry = {
"gzip": GZipCompressor,
"pigz": PigzCompressor,
"bzip2": BZip2Compressor,
"pygzip": PyGZipCompressor,
"pybzip2": PyBZip2Compressor,
"custom": CustomCompressor,
}
#: The longest string needed to identify a compression schema
MAGIC_MAX_LENGTH = max(len(x.MAGIC or "") for x in compression_registry.values())
barman-2.18/barman/backup_manifest.py 0000644 0006212 0006212 00000012711 14172556763 016047 0 ustar 0000000 0000000 # -*- coding: utf-8 -*-
# © Copyright EnterpriseDB UK Limited 2013-2022
#
# This file is part of Barman.
#
# Barman is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Barman is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Barman. If not, see .
import logging
import os
import json
from barman import output
class BackupManifest:
name = "backup_manifest"
def __init__(self, path, file_manager, checksum_algorithm):
"""
:param path: backup directory
:type path: str
:param file_manager: File manager
:type file_manager: barman.
"""
self.files = []
self.path = path
self.file_manager = file_manager
self.checksum_algorithm = checksum_algorithm
def create_backup_manifest(self):
"""
Will create a manifest file if it doesn't exists.
:return:
"""
if self.file_manager.file_exist(self._get_manifest_file_path()):
msg = (
"File %s already exists. Skip file creation."
% self._get_manifest_file_path()
)
logging.info(msg)
output.info(msg)
return
self._create_files_metadata()
str_manifest = self._get_manifest_str()
# Create checksum from string without last '}' and ',' instead
manifest_checksum = self.checksum_algorithm.checksum_from_str(str_manifest)
last_line = '"Manifest-Checksum": "%s"}\n' % manifest_checksum
full_manifest = str_manifest + last_line
self.file_manager.save_content_to_file(
self._get_manifest_file_path(), full_manifest.encode(), file_mode="wb"
)
def _get_manifest_from_dict(self):
"""
Old version used to create manifest first section
Could be used
:return: str
"""
manifest = {
"PostgreSQL-Backup-Manifest-Version": 1,
"Files": self.files,
}
# Convert to text
# sort_keys and separators are used for python compatibility
str_manifest = json.dumps(
manifest, indent=2, sort_keys=True, separators=(",", ": ")
)
str_manifest = str_manifest[:-2] + ",\n"
return str_manifest
def _get_manifest_str(self):
"""
:return:
"""
manifest = '{"PostgreSQL-Backup-Manifest-Version": 1,\n"Files": [\n'
for i in self.files:
# sort_keys needed for python 2/3 compatibility
manifest += json.dumps(i, sort_keys=True) + ",\n"
manifest = manifest[:-2] + "],\n"
return manifest
def _create_files_metadata(self):
"""
Parse all files in backup directory and get file identity values for each one of them.
"""
file_list = self.file_manager.get_file_list(self.path)
for filepath in file_list:
# Create FileEntity
identity = FileIdentity(
filepath, self.path, self.file_manager, self.checksum_algorithm
)
self.files.append(identity.get_value())
def _get_manifest_file_path(self):
"""
Generates backup-manifest file path
:return: backup-manifest file path
:rtype: str
"""
return os.path.join(self.path, self.name)
class FileIdentity:
"""
This class purpose is to aggregate file information for backup-manifest.
"""
def __init__(self, file_path, dir_path, file_manager, checksum_algorithm):
"""
:param file_path: File path to analyse
:type file_path: str
:param dir_path: Backup directory path
:type dir_path: str
:param file_manager:
:type file_manager: barman.storage.FileManager
:param checksum_algorithm: Object that will create checksum from bytes
:type checksum_algorithm:
"""
self.file_path = file_path
self.dir_path = dir_path
self.file_manager = file_manager
self.checksum_algorithm = checksum_algorithm
def get_value(self):
"""
Returns a dictionary containing FileIdentity values
"""
stats = self.file_manager.get_file_stats(self.file_path)
return {
"Size": stats.get_size(),
"Last-Modified": stats.get_last_modified(),
"Checksum-Algorithm": self.checksum_algorithm.get_name(),
"Path": self._get_relative_path(),
"Checksum": self._get_checksum(),
}
def _get_relative_path(self):
"""
:return: file path from directory path
:rtype: string
"""
if not self.file_path.startswith(self.dir_path):
msg = "Expecting %s to start with %s" % (self.file_path, self.dir_path)
raise AttributeError(msg)
return self.file_path.split(self.dir_path)[1].strip("/")
def _get_checksum(self):
"""
:return: file checksum
:rtype: str
"""
content = self.file_manager.get_file_content(self.file_path)
return self.checksum_algorithm.checksum(content)
barman-2.18/barman.egg-info/ 0000755 0006212 0006212 00000000000 14172556766 014035 5 ustar 0000000 0000000 barman-2.18/barman.egg-info/SOURCES.txt 0000644 0006212 0006212 00000017373 14172556766 015734 0 ustar 0000000 0000000 AUTHORS
LICENSE
MANIFEST.in
NEWS
README.rst
setup.cfg
setup.py
barman/__init__.py
barman/annotations.py
barman/backup.py
barman/backup_executor.py
barman/backup_manifest.py
barman/cli.py
barman/cloud.py
barman/command_wrappers.py
barman/compression.py
barman/config.py
barman/copy_controller.py
barman/diagnose.py
barman/exceptions.py
barman/fs.py
barman/hooks.py
barman/infofile.py
barman/lockfile.py
barman/output.py
barman/postgres.py
barman/postgres_plumbing.py
barman/process.py
barman/recovery_executor.py
barman/remote_status.py
barman/retention_policies.py
barman/server.py
barman/utils.py
barman/version.py
barman/wal_archiver.py
barman/xlog.py
barman.egg-info/PKG-INFO
barman.egg-info/SOURCES.txt
barman.egg-info/dependency_links.txt
barman.egg-info/entry_points.txt
barman.egg-info/requires.txt
barman.egg-info/top_level.txt
barman/clients/__init__.py
barman/clients/cloud_backup.py
barman/clients/cloud_backup_delete.py
barman/clients/cloud_backup_keep.py
barman/clients/cloud_backup_list.py
barman/clients/cloud_check_wal_archive.py
barman/clients/cloud_cli.py
barman/clients/cloud_compression.py
barman/clients/cloud_restore.py
barman/clients/cloud_walarchive.py
barman/clients/cloud_walrestore.py
barman/clients/walarchive.py
barman/clients/walrestore.py
barman/cloud_providers/__init__.py
barman/cloud_providers/aws_s3.py
barman/cloud_providers/azure_blob_storage.py
barman/storage/__init__.py
barman/storage/file_manager.py
barman/storage/file_stats.py
barman/storage/local_file_manager.py
doc/.gitignore
doc/Makefile
doc/barman-cloud-backup-delete.1
doc/barman-cloud-backup-delete.1.md
doc/barman-cloud-backup-keep.1
doc/barman-cloud-backup-keep.1.md
doc/barman-cloud-backup-list.1
doc/barman-cloud-backup-list.1.md
doc/barman-cloud-backup.1
doc/barman-cloud-backup.1.md
doc/barman-cloud-check-wal-archive.1
doc/barman-cloud-check-wal-archive.1.md
doc/barman-cloud-restore.1
doc/barman-cloud-restore.1.md
doc/barman-cloud-wal-archive.1
doc/barman-cloud-wal-archive.1.md
doc/barman-cloud-wal-restore.1
doc/barman-cloud-wal-restore.1.md
doc/barman-wal-archive.1
doc/barman-wal-archive.1.md
doc/barman-wal-restore.1
doc/barman-wal-restore.1.md
doc/barman.1
doc/barman.5
doc/barman.conf
doc/barman.1.d/00-header.md
doc/barman.1.d/05-name.md
doc/barman.1.d/10-synopsis.md
doc/barman.1.d/15-description.md
doc/barman.1.d/20-options.md
doc/barman.1.d/45-commands.md
doc/barman.1.d/50-archive-wal.md
doc/barman.1.d/50-backup.md
doc/barman.1.d/50-check-backup.md
doc/barman.1.d/50-check-wal-archive.md
doc/barman.1.d/50-check.md
doc/barman.1.d/50-cron.md
doc/barman.1.d/50-delete.md
doc/barman.1.d/50-diagnose.md
doc/barman.1.d/50-get-wal.md
doc/barman.1.d/50-keep.md
doc/barman.1.d/50-list-backups.md
doc/barman.1.d/50-list-files.md
doc/barman.1.d/50-list-servers.md
doc/barman.1.d/50-put-wal.md
doc/barman.1.d/50-rebuild-xlogdb.md
doc/barman.1.d/50-receive-wal.md
doc/barman.1.d/50-recover.md
doc/barman.1.d/50-replication-status.md
doc/barman.1.d/50-show-backup.md
doc/barman.1.d/50-show-servers.md
doc/barman.1.d/50-status.md
doc/barman.1.d/50-switch-wal.md
doc/barman.1.d/50-switch-xlog.md
doc/barman.1.d/50-sync-backup.md
doc/barman.1.d/50-sync-info.md
doc/barman.1.d/50-sync-wals.md
doc/barman.1.d/70-backup-id-shortcuts.md
doc/barman.1.d/75-exit-status.md
doc/barman.1.d/80-see-also.md
doc/barman.1.d/85-bugs.md
doc/barman.1.d/90-authors.md
doc/barman.1.d/95-resources.md
doc/barman.1.d/99-copying.md
doc/barman.5.d/00-header.md
doc/barman.5.d/05-name.md
doc/barman.5.d/15-description.md
doc/barman.5.d/20-configuration-file-locations.md
doc/barman.5.d/25-configuration-file-syntax.md
doc/barman.5.d/30-configuration-file-directory.md
doc/barman.5.d/45-options.md
doc/barman.5.d/50-active.md
doc/barman.5.d/50-archiver.md
doc/barman.5.d/50-archiver_batch_size.md
doc/barman.5.d/50-backup_directory.md
doc/barman.5.d/50-backup_method.md
doc/barman.5.d/50-backup_options.md
doc/barman.5.d/50-bandwidth_limit.md
doc/barman.5.d/50-barman_home.md
doc/barman.5.d/50-barman_lock_directory.md
doc/barman.5.d/50-basebackup_retry_sleep.md
doc/barman.5.d/50-basebackup_retry_times.md
doc/barman.5.d/50-basebackups_directory.md
doc/barman.5.d/50-check_timeout.md
doc/barman.5.d/50-compression.md
doc/barman.5.d/50-conninfo.md
doc/barman.5.d/50-create_slot.md
doc/barman.5.d/50-custom_compression_filter.md
doc/barman.5.d/50-custom_compression_magic.md
doc/barman.5.d/50-custom_decompression_filter.md
doc/barman.5.d/50-description.md
doc/barman.5.d/50-errors_directory.md
doc/barman.5.d/50-forward-config-path.md
doc/barman.5.d/50-immediate_checkpoint.md
doc/barman.5.d/50-incoming_wals_directory.md
doc/barman.5.d/50-last_backup_maximum_age.md
doc/barman.5.d/50-last_backup_minimum_size.md
doc/barman.5.d/50-last_wal_maximum_age.md
doc/barman.5.d/50-log_file.md
doc/barman.5.d/50-log_level.md
doc/barman.5.d/50-max_incoming_wals_queue.md
doc/barman.5.d/50-minimum_redundancy.md
doc/barman.5.d/50-network_compression.md
doc/barman.5.d/50-parallel_jobs.md
doc/barman.5.d/50-path_prefix.md
doc/barman.5.d/50-post_archive_retry_script.md
doc/barman.5.d/50-post_archive_script.md
doc/barman.5.d/50-post_backup_retry_script.md
doc/barman.5.d/50-post_backup_script.md
doc/barman.5.d/50-post_delete_retry_script.md
doc/barman.5.d/50-post_delete_script.md
doc/barman.5.d/50-post_recovery_retry_script.md
doc/barman.5.d/50-post_recovery_script.md
doc/barman.5.d/50-post_wal_delete_retry_script.md
doc/barman.5.d/50-post_wal_delete_script.md
doc/barman.5.d/50-pre_archive_retry_script.md
doc/barman.5.d/50-pre_archive_script.md
doc/barman.5.d/50-pre_backup_retry_script.md
doc/barman.5.d/50-pre_backup_script.md
doc/barman.5.d/50-pre_delete_retry_script.md
doc/barman.5.d/50-pre_delete_script.md
doc/barman.5.d/50-pre_recovery_retry_script.md
doc/barman.5.d/50-pre_recovery_script.md
doc/barman.5.d/50-pre_wal_delete_retry_script.md
doc/barman.5.d/50-pre_wal_delete_script.md
doc/barman.5.d/50-primary_ssh_command.md
doc/barman.5.d/50-recovery_options.md
doc/barman.5.d/50-retention_policy.md
doc/barman.5.d/50-retention_policy_mode.md
doc/barman.5.d/50-reuse_backup.md
doc/barman.5.d/50-slot_name.md
doc/barman.5.d/50-ssh_command.md
doc/barman.5.d/50-streaming_archiver.md
doc/barman.5.d/50-streaming_archiver_batch_size.md
doc/barman.5.d/50-streaming_archiver_name.md
doc/barman.5.d/50-streaming_backup_name.md
doc/barman.5.d/50-streaming_conninfo.md
doc/barman.5.d/50-streaming_wals_directory.md
doc/barman.5.d/50-tablespace_bandwidth_limit.md
doc/barman.5.d/50-wal_retention_policy.md
doc/barman.5.d/50-wals_directory.md
doc/barman.5.d/70-hook-scripts.md
doc/barman.5.d/75-example.md
doc/barman.5.d/80-see-also.md
doc/barman.5.d/90-authors.md
doc/barman.5.d/95-resources.md
doc/barman.5.d/99-copying.md
doc/barman.d/passive-server.conf-template
doc/barman.d/ssh-server.conf-template
doc/barman.d/streaming-server.conf-template
doc/images/barman-architecture-georedundancy.png
doc/images/barman-architecture-scenario1.png
doc/images/barman-architecture-scenario1b.png
doc/images/barman-architecture-scenario2.png
doc/images/barman-architecture-scenario2b.png
doc/manual/.gitignore
doc/manual/00-head.en.md
doc/manual/01-intro.en.md
doc/manual/02-before_you_start.en.md
doc/manual/10-design.en.md
doc/manual/15-system_requirements.en.md
doc/manual/16-installation.en.md
doc/manual/17-configuration.en.md
doc/manual/20-server_setup.en.md
doc/manual/21-preliminary_steps.en.md
doc/manual/22-config_file.en.md
doc/manual/23-wal_streaming.en.md
doc/manual/24-wal_archiving.en.md
doc/manual/25-streaming_backup.en.md
doc/manual/26-rsync_backup.en.md
doc/manual/27-windows-support.en.md
doc/manual/41-global-commands.en.md
doc/manual/42-server-commands.en.md
doc/manual/43-backup-commands.en.md
doc/manual/50-feature-details.en.md
doc/manual/55-barman-cli.en.md
doc/manual/65-troubleshooting.en.md
doc/manual/66-about.en.md
doc/manual/70-feature-matrix.en.md
doc/manual/99-references.en.md
doc/manual/Makefile
scripts/barman.bash_completion barman-2.18/barman.egg-info/dependency_links.txt 0000644 0006212 0006212 00000000001 14172556766 020103 0 ustar 0000000 0000000
barman-2.18/barman.egg-info/requires.txt 0000644 0006212 0006212 00000000205 14172556766 016432 0 ustar 0000000 0000000 psycopg2>=2.4.2
python-dateutil
argcomplete
[azure]
azure-identity
azure-storage-blob
[cloud]
boto3
[snappy]
python-snappy>=0.6.0
barman-2.18/barman.egg-info/entry_points.txt 0000644 0006212 0006212 00000001230 14172556766 017327 0 ustar 0000000 0000000 [console_scripts]
barman = barman.cli:main
barman-cloud-backup = barman.clients.cloud_backup:main
barman-cloud-backup-delete = barman.clients.cloud_backup_delete:main
barman-cloud-backup-keep = barman.clients.cloud_backup_keep:main
barman-cloud-backup-list = barman.clients.cloud_backup_list:main
barman-cloud-check-wal-archive = barman.clients.cloud_check_wal_archive:main
barman-cloud-restore = barman.clients.cloud_restore:main
barman-cloud-wal-archive = barman.clients.cloud_walarchive:main
barman-cloud-wal-restore = barman.clients.cloud_walrestore:main
barman-wal-archive = barman.clients.walarchive:main
barman-wal-restore = barman.clients.walrestore:main
barman-2.18/barman.egg-info/PKG-INFO 0000644 0006212 0006212 00000002750 14172556766 015136 0 ustar 0000000 0000000 Metadata-Version: 2.1
Name: barman
Version: 2.18
Summary: Backup and Recovery Manager for PostgreSQL
Home-page: https://www.pgbarman.org/
Author: EnterpriseDB
Author-email: barman@enterprisedb.com
License: GPL-3.0
Description: Barman (Backup and Recovery Manager) is an open-source administration
tool for disaster recovery of PostgreSQL servers written in Python.
It allows your organisation to perform remote backups of multiple
servers in business critical environments to reduce risk and help DBAs
during the recovery phase.
Barman is distributed under GNU GPL 3 and maintained by EnterpriseDB.
Platform: Linux
Platform: Mac OS X
Classifier: Environment :: Console
Classifier: Development Status :: 5 - Production/Stable
Classifier: Topic :: System :: Archiving :: Backup
Classifier: Topic :: Database
Classifier: Topic :: System :: Recovery Tools
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Provides-Extra: azure
Provides-Extra: snappy
Provides-Extra: cloud
barman-2.18/barman.egg-info/top_level.txt 0000644 0006212 0006212 00000000007 14172556766 016564 0 ustar 0000000 0000000 barman
barman-2.18/README.rst 0000644 0006212 0006212 00000004330 14172556763 012567 0 ustar 0000000 0000000 Barman, Backup and Recovery Manager for PostgreSQL
==================================================
This is the new (starting with version 2.13) home of Barman. It replaces
the legacy sourceforge repository.
Barman (Backup and Recovery Manager) is an open-source administration
tool for disaster recovery of PostgreSQL servers written in Python. It
allows your organisation to perform remote backups of multiple servers
in business critical environments to reduce risk and help DBAs during
the recovery phase.
Barman is distributed under GNU GPL 3 and maintained by EnterpriseDB.
For further information, look at the "Web resources" section below.
Source content
--------------
Here you can find a description of files and directory distributed with
Barman:
- AUTHORS : development team of Barman
- NEWS : release notes
- ChangeLog : log of changes
- LICENSE : GNU GPL3 details
- TODO : our wishlist for Barman
- barman : sources in Python
- doc : tutorial and man pages
- scripts : auxiliary scripts
- tests : unit tests
Web resources
-------------
- Website : http://www.pgbarman.org/
- Download : http://github.com/EnterpriseDB/barman
- Documentation : http://www.pgbarman.org/documentation/
- Man page, section 1 : http://docs.pgbarman.org/barman.1.html
- Man page, section 5 : http://docs.pgbarman.org/barman.5.html
- Community support : http://www.pgbarman.org/support/
- Professional support : https://www.enterprisedb.com/
- pgespresso extension : https://github.com/2ndquadrant-it/pgespresso
- pre barman 2.13 versions : https://sourceforge.net/projects/pgbarman/files/
Licence
-------
© Copyright 2011-2022 EnterpriseDB UK Limited
Barman is free software: you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free
Software Foundation, either version 3 of the License, or (at your
option) any later version.
Barman is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
more details.
You should have received a copy of the GNU General Public License along
with Barman. If not, see http://www.gnu.org/licenses/.
barman-2.18/NEWS 0000644 0006212 0006212 00000123653 14172556763 011611 0 ustar 0000000 0000000 Barman News - History of user-visible changes
Version 2.18 - 21 January 2022
- Add snappy compression algorithm support in barman cloud (requires the
optional python-snappy dependency).
- Allow Azure client concurrency parameters to be set when uploading
WALs with barman-cloud-wal-archive.
- Add `--tags` option in barman cloud so that backup files and archived
WALs can be tagged in cloud storage (aws and azure).
- Update the barman cloud exit status codes so that there is a dedicated
code (2) for connectivity errors.
- Add the commands `barman verify-backup` and `barman generate-manifest`
to check if a backup is valid.
- Add support for Azure Managed Identity auth in barman cloud which can
be enabled with the `--credential` option.
- Bug fixes:
- Change `barman-cloud-check-wal-archive` behavior when bucket does
not exist.
- Ensure `list-files` output is always sorted regardless of the
underlying filesystem.
- Man pages for barman-cloud-backup-keep, barman-cloud-backup-delete
and barman-cloud-check-wal-archive added to Python packaging.
- We thank richyen and stratakis for their contributions to this
release.
Version 2.17 - 1 December 2021
- Bug fixes:
- Resolves a performance regression introduced in version 2.14 which
increased copy times for `barman backup` or `barman recover` commands
when using the `--jobs` flag.
- Ignore rsync partial transfer errors for `sender` processes so that
such errors do not cause the backup to fail (thanks to barthisrael).
Version 2.16 - 17 November 2021
- Add the commands `barman-check-wal-archive` and `barman-cloud-check-wal-archive`
to validate if a proposed archive location is safe to use for a new PostgreSQL
server.
- Allow Barman to identify WAL that's already compressed using a custom
compression scheme to avoid compressing it again.
- Add `last_backup_minimum_size` and `last_wal_maximum_age` options to
`barman check`.
- Bug fixes:
- Use argparse for command line parsing instead of the unmaintained
argh module.
- Make timezones consistent for `begin_time` and `end_time`.
- We thank chtitux, George Hansper, stratakis, Thoro, and vrms for their
contributions to this release.
Version 2.15 - 12 October 2021
- Add plural forms for the `list-backup`, `list-server` and
`show-server` commands which are now `list-backups`, `list-servers`
and `show-servers`. The singular forms are retained for backward
compatibility.
- Add the `last-failed` backup shortcut which references the newest
failed backup in the catalog so that you can do:
- `barman delete last-failed`
- Bug fixes:
- Tablespaces will no longer be omitted from backups of EPAS
versions 9.6 and 10 due to an issue detecting the correct version
string on older versions of EPAS.
Version 2.14 - 22 September 2021
- Add the `barman-cloud-backup-delete` command which allows backups in
cloud storage to be deleted by specifying either a backup ID or a
retention policy.
- Allow backups to be retained beyond any retention policies in force by
introducing the ability to tag existing backups as archival backups
using `barman keep` and `barman-cloud-backup-keep`.
- Allow the use of SAS authentication tokens created at the restricted
blob container level (instead of the wider storage account level) for
Azure blob storage
- Significantly speed up `barman restore` into an empty directory for
backups that contain hundreds of thousands of files.
- Bug fixes:
- The backup privileges check will no longer fail if the user lacks
"userepl" permissions and will return better error messages if any
required permissions are missing (#318 and #319).
Version 2.13 - 26 July 2021
- Add Azure blob storage support to barman-cloud
- Support tablespace remapping in barman-cloud-restore via
`--tablespace name:location`
- Allow barman-cloud-backup and barman-cloud-wal-archive to run as
Barman hook scripts, to allow data to be relayed to cloud storage
from the Barman server
- Bug fixes:
- Stop backups failing due to idle_in_transaction_session_timeout
(https://github.com/EnterpriseDB/barman/issues/333)
- Fix a race condition between backup and archive-wal in updating
xlog.db entries (#328)
- Handle PGDATA being a symlink in barman-cloud-backup, which led to
"seeking backwards is not allowed" errors on restore (#351)
- Recreate pg_wal on restore if the original was a symlink (#327)
- Recreate pg_tblspc symlinks for tablespaces on restore (#343)
- Make barman-cloud-backup-list skip backups it cannot read, e.g.,
because they are in Glacier storage (#332)
- Add `-d database` option to barman-cloud-backup to specify which
database to connect to initially (#307)
- Fix "Backup failed uploading data" errors from barman-cloud-backup
on Python 3.8 and above, caused by attempting to pickle the boto3
client (#361)
- Correctly enable server-side encryption in S3 for buckets that do
not have encryption enabled by default.
In Barman 2.12, barman-cloud-backup's `--encryption` option did
not correctly enable encryption for the contents of the backup if
the backup was stored in an S3 bucket that did not have encryption
enabled. If this is the case for you, please consider deleting
your old backups and taking new backups with Barman 2.13.
If your S3 buckets already have encryption enabled by default
(which we recommend), this does not affect you.
Version 2.12.1 - 30 June 2021
- Bug fixes:
- Allow specifying target-tli with other target-* recovery options
- Fix incorrect NAME in barman-cloud-backup-list manpage
- Don't raise an error if SIGALRM is ignored
- Fetch wal_keep_size, not wal_keep_segments, from Postgres 13
Version 2.12 - 5 Nov 2020
- Introduce a new backup_method option called local-rsync which
targets those cases where Barman is installed on the same server
where PostgreSQL is and directly uses rsync to take base backups,
bypassing the SSH layer.
- Bug fixes:
- Avoid corrupting boto connection in worker processes
- Avoid connection attempts to PostgreSQL during tests
Version 2.11 - 9 Jul 2020
- Introduction of the barman-cli-cloud package that contains all cloud
related utilities.
- Add barman-cloud-wal-restore to restore a WAL file previously
archived with barman-cloud-wal-archive from an object store
- Add barman-cloud-restore to restore a backup previously taken with
barman-cloud-backup from an object store
- Add barman-cloud-backup-list to list backups taken with
barman-cloud-backup in an object store
- Add support for arbitrary archive size for barman-cloud-backup
- Add support for --endpoint-url option to cloud utilities
- Remove strict superuser requirement for PG 10+ (by Kaarel Moppel)
- Add --log-level runtime option for barman to override default log
level for a specific command
- Support for PostgreSQL 13
- Bug fixes:
- Suppress messages and warning with SSH connections in barman-cli
(GH-257)
- Fix a race condition when retrieving uploaded parts in
barman-cloud-backup (GH-259)
- Close the PostgreSQL connection after a backup (GH-258)
- Check for uninitialized replication slots in receive-wal --reset
(GH-260)
- Ensure that begin_wal is valorised before acting on it (GH-262)
- Fix bug in XLOG/WAL arithmetic with custom segment size (GH-287)
- Fix rsync compatibility error with recent rsync
- Fix PostgreSQLClient version parsing
- Fix PostgreSQL exception handling with non ASCII messages
- Ensure each postgres connection has an empty search_path
- Avoid connecting to PostgreSQL while reading a backup.info file
If you are using already barman-cloud-wal-archive or barman-cloud-backup
installed via RPM/Apt package and you are upgrading your system, you
must install the barman-cli-cloud package. All cloud related tools are
now part of the barman-cli-cloud package, including
barman-cloud-wal-archive and barman-cloud-backup that were previosly
shipped with barman-cli. The reason is complex dependency management of
the boto3 library, which is a requirement for the cloud utilities.
Version 2.10 - 5 Dec 2019
- Pull .partial WAL files with get-wal and barman-wal-restore,
allowing restore_command in a recovery scenario to fetch a partial
WAL file's content from the Barman server. This feature simplifies
and enhances RPO=0 recovery operations.
- Store the PostgreSQL system identifier in the server directory and
inside the backup information file. Improve check command to verify
the consistency of the system identifier with active connections
(standard and replication) and data on disk.
- A new script called barman-cloud-wal-archive has been added to the
barman-cli package to directly ship WAL files from PostgreSQL (using
archive_command) to cloud object storage services that are
compatible with AWS S3. It supports encryption and compression.
- A new script called barman-cloud-backup has been added to the
barman-cli package to directly ship base backups from a local
PostgreSQL server to cloud object storage services that are
compatible with AWS S3. It supports encryption, parallel upload,
compression.
- Automated creation of replication slots through the server/global
option create_slot. When set to auto, Barman creates the replication
slot, in case streaming_archiver is enabled and slot_name is
defined. The default value is manual for back-compatibility.
- Add '-w/--wait' option to backup command, making Barman wait for all
required WAL files to be archived before considering the backup
completed. Add also the --wait-timeout option (default 0, no
timeout).
- Redact passwords from Barman output, in particular from
barman diagnose (InfoSec)
- Improve robustness of receive-wal --reset command, by verifying that
the last partial file is aligned with the current location or, if
present, with replication slot's.
- Documentation improvements
- Bug fixes:
- Wrong string matching operation when excluding tablespaces
inside PGDATA (GH-245)
- Minor fixes in WAL delete hook scripts (GH-240)
- Fix PostgreSQL connection aliveness check (GH-239)
Version 2.9 - 1 Aug 2019
- Transparently support PostgreSQL 12, by supporting the new way of
managing recovery and standby settings through GUC options and
signal files (recovery.signal and standby.signal)
- Add --bwlimit command line option to set bandwidth limitation for
backup and recover commands
- Ignore WAL archive failure for check command in case the latest
backup is WAITING_FOR_WALS
- Add --target-lsn option to set recovery target Log Sequence Number
for recover command with PostgreSQL 10 or higher
- Add --spool-dir option to barman-wal-restore so that users can
change the spool directory location from the default, avoiding
conflicts in case of multiple PostgreSQL instances on the same
server (thanks to Drazen Kacar).
- Rename barman_xlog directory to barman_wal
- JSON output writer to export command output as JSON objects and
facilitate integration with external tools and systems (thanks to
Marcin Onufry Hlybin). Experimental in this release.
Bug fixes:
- replication-status doesn’t show streamers with no slot (GH-222)
- When checking that a connection is alive (“SELECT 1” query),
preserve the status of the PostgreSQL connection (GH-149). This
fixes those cases of connections that were terminated due to
idle-in-transaction timeout, causing concurrent backups to fail.
Version 2.8 - 17 May 2019
- Add support for reuse_backup in geo-redundancy for incremental
backup copy in passive nodes
- Improve performance of rsync based copy by using strptime instead of
the more generic dateutil.parser (#210)
- Add ‘--test’ option to barman-wal-archive and barman-wal-restore to
verify the connection with the Barman server
- Complain if backup_options is not explicitly set, as the future
default value will change from exclusive_backup to concurrent_backup
when PostgreSQL 9.5 will be declared EOL by the PGDG
- Display additional settings in the show-server and diagnose
commands: archive_timeout, data_checksums, hot_standby,
max_wal_senders, max_replication_slots and wal_compression.
- Merge the barman-cli project in Barman
- Bug fixes:
- Fix encoding error in get-wal on Python 3 (Jeff Janes, #221)
- Fix exclude_and_protect_filter (Jeff Janes, #217)
- Remove spurious message when resetting WAL (Jeff Janes, #215)
- Fix sync-wals error if primary has WALs older than the first
backup
- Support for double quotes in synchronous_standby_names setting
- Minor changes:
- Improve messaging of check --nagios for inactive servers
- Log remote SSH command with recover command
- Hide logical decoding connections in replication-status command
This release officially supports Python 3 and deprecates Python 2 (which
might be discontinued in future releases).
PostgreSQL 9.3 and older is deprecated from this release of Barman.
Support for backup from standby is now limited to PostgreSQL 9.4 or
higher and to WAL shipping from the standby (please refer to the
documentation for details).
Version 2.7 - 21 Mar 2019
- Fix error handling during the parallel backup. Previously an
unrecoverable error during the copy could have corrupted the barman
internal state, requiring a manual kill of barman process with
SIGTERM and a manual cleanup of the running backup in PostgreSQL.
(GH#199)
- Fix support of UTF-8 characters in input and output (GH#194 and
GH#196)
- Ignore history/backup/partial files for first sync of geo-redundancy
(GH#198)
- Fix network failure with geo-redundancy causing cron to break
(GH#202)
- Fix backup validation in PostgreSQL older than 9.2
- Various documentation fixes
Version 2.6 - 4 Feb 2019
- Add support for Geographical redundancy, introducing 3 new commands:
sync-info, sync-backup and sync-wals. Geo-redundancy allows a Barman
server to use another Barman server as data source instead of a
PostgreSQL server.
- Add put-wal command that allows Barman to safely receive WAL files
via PostgreSQL's archive_command using the barman-wal-archive script
included in barman-cli
- Add ANSI colour support to check command
- Minor fixes:
- Fix switch-wal on standby with an empty WAL directory
- Honour archiver locking in wait_for_wal method
- Fix WAL compression detection algorithm
- Fix current_action in concurrent stop backup errors
- Do not treat lock file busy as an error when validating a backup
Version 2.5 - 23 Oct 2018
- Add support for PostgreSQL 11
- Add check-backup command to verify that WAL files required for
consistency of a base backup are present in the archive. Barman now
adds a new state (WAITING_FOR_WALS) after completing a base backup,
and sets it to DONE once it has verified that all WAL files from
start to the end of the backup exist. This command is included in
the regular cron maintenance job. Barman now notifies users
attempting to recover a backup that is in WAITING_FOR_WALS state.
- Allow switch-xlog --archive to work on a standby (just for the
archive part)
- Bug fixes:
- Fix decoding errors reading external commands output (issue
#174)
- Fix documentation regarding WAL streaming and backup from
standby
Version 2.4 - 25 May 2018
- Add standard and retry hook scripts for backup deletion (pre/post)
- Add standard and retry hook scripts for recovery (pre/post)
- Add standard and retry hook scripts for WAL deletion (pre/post)
- Add --standby-mode option to barman recover to add standby_mode = on
in pre-generated recovery.conf
- Add --target-action option to barman recover, allowing users to add
shutdown, pause or promote to the pre-generated recovery.conf file
- Improve usability of point-in-time recovery with consistency checks
(e.g. recovery time is after end time of backup)
- Minor documentation improvements
- Drop support for Python 3.3
Relevant bug fixes:
- Fix remote get_file_content method (Github #151), preventing
incremental recovery from happening
- Unicode issues with command (Github #143 and #150)
- Add --wal-method=none when pg_basebackup >= 10 (Github #133)
Minor bug fixes:
- Stop process manager module from ovewriting lock files content
- Relax the rules for rsync output parsing
- Ignore vanished files in streaming directory
- Case insensitive slot names (Github #170)
- Make DataTransferFailure.from_command_error() more resilient
(Github #86)
- Rename command() to barman_command() (Github #118)
- Initialise synchronous standby names list if not set (Github #111)
- Correct placeholders ordering (GitHub #138)
- Force datestyle to iso for replication connections
- Returns error if delete command does not remove the backup
- Fix exception when calling is_power_of_two(None)
- Downgraded sync standby names messages to debug (Github #89)
Version 2.3 - 5 Sep 2017
- Add support to PostgreSQL 10
- Follow naming changes in PostgreSQL 10:
- The switch-xlog command has been renamed to switch-wal.
- In commands output, the xlog word has been changed to WAL and
location has been changed to LSN when appropriate.
- Add the --network-compression/--no-network-compression options to
barman recover to enable or disable network compression at run-time
- Add --target-immediate option to recover command, in order to exit
recovery when a consistent state is reached (end of the backup,
available from PostgreSQL 9.4)
- Show cluster state (master or standby) with barman status command
- Documentation improvements
- Bug fixes:
- Fix high memory usage with parallel_jobs > 1 (#116)
- Better handling of errors using parallel copy (#114)
- Make barman diagnose more robust with system exceptions
- Let archive-wal ignore files with .tmp extension
Version 2.2 - 17 Jul 2017
- Implement parallel copy for backup/recovery through the
parallel_jobs global/server option to be overridden by the --jobs or
-j runtime option for the backup and recover command. Parallel
backup is available only for the rsync copy method. By default, it
is set to 1 (for behaviour compatibility with previous versions).
- Support custom WAL size for PostgreSQL 8.4 and newer. At backup
time, Barman retrieves from PostgreSQL wal_segment_size and
wal_block_size values and computes the necessary calculations.
- Improve check command to ensure that incoming directory is empty
when archiver=off, and streaming directory is empty when
streaming_archiver=off (#80).
- Add external_configuration to backup_options so that users can
instruct Barman to ignore backup of configuration files when they
are not inside PGDATA (default for Debian/Ubuntu installations). In
this case, Barman does not display a warning anymore.
- Add --get-wal and --no-get-wal options to barman recover
- Add max_incoming_wals_queue global/server option for the check
command so that a non blocking error is returned in case incoming
WAL directories for both archiver and the streaming_archiver contain
more files than the specified value.
- Documentation improvements
- File format changes:
- The format of backup.info file has changed. For this reason a
backup taken with Barman 2.2 cannot be read by a previous
version of Barman. But, backups taken by previous versions can
be read by Barman 2.2.
- Minor bug fixes:
- Allow replication-status to work against a standby
- Close any PostgreSQL connection before starting pg_basebackup
(#104, #108)
- Safely handle paths containing special characters
- Archive .partial files after promotion of streaming source
- Recursively create directories during recovery (SF#44)
- Improve xlog.db locking (#99)
- Remove tablespace_map file during recover (#95)
- Reconnect to PostgreSQL if connection drops (SF#82)
Version 2.1 - 5 Jan 2017
- Add --archive and --archive-timeout options to switch-xlog command
- Preliminary support for PostgreSQL 10 (#73)
- Minor additions:
- Add last archived WAL info to diagnose output
- Add start time and execution time to the output of delete
command
- Minor bug fixes:
- Return failure for get-wal command on inactive server
- Make streaming_archiver_names and streaming_backup_name options
global (#57)
- Fix rsync failures due to files truncated during transfer (#64)
- Correctly handle compressed history files (#66)
- Avoid de-referencing symlinks in pg_tblspc when preparing
recovery (#55)
- Fix comparison of last archiving failure (#40, #58)
- Avoid failing recovery if postgresql.conf is not writable (#68)
- Fix output of replication-status command (#56)
- Exclude files from backups like pg_basebackup (#65, #72)
- Exclude directories from other Postgres versions while copying
tablespaces (#74)
- Make retry hook script options global
Version 2.0 - 27 Sep 2016
- Support for pg_basebackup and base backups over the PostgreSQL
streaming replication protocol with backup_method=postgres
(PostgreSQL 9.1 or higher required)
- Support for physical replication slots through the slot_name
configuration option as well as the --create-slot and --drop-slot
options for the receive-wal command (PostgreSQL 9.4 or higher
required). When slot_name is specified and streaming_archiver is
enabled, receive-wal transparently integrates with pg_receivexlog,
and check makes sure that slots exist and are actively used
- Support for the new backup API introduced in PostgreSQL 9.6, which
transparently enables concurrent backups and backups from standby
servers using the standard rsync method of backup. Concurrent backup
was only possible for PostgreSQL 9.2 to 9.5 versions through the
pgespresso extension. The new backup API will make pgespresso
redundant in the future
- If properly configured, Barman can function as a synchronous standby
in terms of WAL streaming. By properly setting the
streaming_archiver_name in the synchronous_standby_names priority
list on the master, and enabling replication slot support, the
receive-wal command can now be part of a PostgreSQL synchronous
replication cluster, bringing RPO=0 (PostgreSQL 9.5.5 or
higher required)
- Introduce barman-wal-restore, a standard and robust script written
in Python that can be used as restore_command in recovery.conf files
of any standby server of a cluster. It supports remote parallel
fetching of WAL files by efficiently invoking get-wal through SSH.
Currently available as a separate project called barman-cli. The
barman-cli package is required for remote recovery when get-wal is
listed in recovery_options
- Control the maximum execution time of the check command through the
check_timeout global/server configuration option (30 seconds
by default)
- Limit the number of WAL segments that are processed by an
archive-wal run, through the archiver_batch_size and
streaming_archiver_batch_size global/server options which control
archiving of WAL segments coming from, respectively, the standard
archiver and receive-wal
- Removed locking of the XLOG database during check operations
- The show-backup command is now aware of timelines and properly
displays which timelines can be used as recovery targets for a given
base backup. Internally, Barman is now capable of parsing .history
files
- Improved the logic behind the retry mechanism when copy operations
experience problems. This involves backup (rsync and postgres) as
well as remote recovery (rsync)
- Code refactoring involving remote command and physical copy
interfaces
- Bug fixes:
- Correctly handle .history files from streaming
- Fix replication-status on PostgreSQL 9.1
- Fix replication-status when sent and write locations are not
available
- Fix misleading message on pg_receivexlog termination
Version 1.6.1 - 23 May 2016
- Add --peek option to get-wal command to discover existing WAL files
from the Barman's archive
- Add replication-status command for monitoring the status of any
streaming replication clients connected to the PostgreSQL server.
The --target option allows users to limit the request to only hot
standby servers or WAL streaming clients
- Add the switch-xlog command to request a switch of a WAL file to the
PostgreSQL server. Through the '--force' it issues a CHECKPOINT
beforehand
- Add streaming_archiver_name option, which sets a proper
application_name to pg_receivexlog when streaming_archiver is
enabled (only for PostgreSQL 9.3 and above)
- Check for _superuser_ privileges with PostgreSQL's standard
connections (#30)
- Check the WAL archive is never empty
- Check for 'backup_label' on the master when server is down
- Improve barman-wal-restore contrib script
- Bug fixes:
- Treat the "failed backups" check as non-fatal
- Rename '-x' option for get-wal as '-z'
- Add archive_mode=always support for PostgreSQL 9.5 (#32)
- Properly close PostgreSQL connections when necessary
- Fix receive-wal for pg_receive_xlog version 9.2
Version 1.6.0 - 29 Feb 2016
- Support for streaming replication connection through the
streaming_conninfo server option
- Support for the streaming_archiver option that allows Barman to
receive WAL files through PostgreSQL's native streaming protocol.
When set to 'on', it relies on pg_receivexlog to receive WAL data,
reducing Recovery Point Objective. Currently, WAL streaming is an
additional feature (standard log archiving is still required)
- Implement the receive-wal command that, when streaming_archiver is
on, wraps pg_receivexlog for WAL streaming. Add --stop option to
stop receiving WAL files via streaming protocol. Add --reset option
to reset the streaming status and restart from the current xlog
in Postgres.
- Automatic management (startup and stop) of receive-wal command via
cron command
- Support for the path_prefix configuration option
- Introduction of the archiver option (currently fixed to on) which
enables continuous WAL archiving for a specific server, through log
shipping via PostgreSQL's archive_command
- Support for streaming_wals_directory and errors_directory options
- Management of WAL duplicates in archive-wal command and integration
with check command
- Verify if pg_receivexlog is running in check command when
streaming_archiver is enabled
- Verify if failed backups are present in check command
- Accept compressed WAL files in incoming directory
- Add support for the pigz compressor (thanks to Stefano Zacchiroli
zack@upsilon.cc)
- Implement pygzip and pybzip2 compressors (based on an initial idea
of Christoph Moench-Tegeder christoph@2ndquadrant.de)
- Creation of an implicit restore point at the end of a backup
- Current size of the PostgreSQL data files in barman status
- Permit archive_mode=always for PostgreSQL 9.5 servers (thanks to
Christoph Moench-Tegeder christoph@2ndquadrant.de)
- Complete refactoring of the code responsible for connecting to
PostgreSQL
- Improve messaging of cron command regarding sub-processes
- Native support for Python >= 3.3
- Changes of behaviour:
- Stop trashing WAL files during archive-wal (commit:e3a1d16)
- Bug fixes:
- Atomic WAL file archiving (#9 and #12)
- Propagate "-c" option to any Barman subprocess (#19)
- Fix management of backup ID during backup deletion (#22)
- Improve archive-wal robustness and log messages (#24)
- Improve error handling in case of missing parameters
Version 1.5.1 - 16 Nov 2015
- Add support for the 'archive-wal' command which performs WAL
maintenance operations on a given server
- Add support for "per-server" concurrency of the 'cron' command
- Improved management of xlog.db errors
- Add support for mixed compression types in WAL files (SF.net#61)
- Bug fixes:
- Avoid retention policy checks during the recovery
- Avoid 'wal_level' check on PostgreSQL version < 9.0 (#3)
- Fix backup size calculation (#5)
Version 1.5.0 - 28 Sep 2015
- Add support for the get-wal command which allows users to fetch any
WAL file from the archive of a specific server
- Add support for retry hook scripts, a special kind of hook scripts
that Barman tries to run until they succeed
- Add active configuration option for a server to temporarily disable
the server by setting it to False
- Add barman_lock_directory global option to change the location of
lock files (by default: 'barman_home')
- Execute the full suite of checks before starting a backup, and skip
it in case one or more checks fail
- Forbid to delete a running backup
- Analyse include directives of a PostgreSQL server during backup and
recover operations
- Add check for conflicting paths in the configuration of Barman, both
intra (by temporarily disabling a server) and inter-server (by
refusing any command, to any server).
- Add check for wal_level
- Add barman-wal-restore script to be used as restore_command on a
standby server, in conjunction with barman get-wal
- Implement a standard and consistent policy for error management
- Improved cache management of backups
- Improved management of configuration in unit tests
- Tutorial and man page sources have been converted to Markdown format
- Add code documentation through Sphinx
- Complete refactor of the code responsible for managing the backup
and the recover commands
- Changed internal directory structure of a backup
- Introduce copy_method option (currently fixed to rsync)
- Bug fixes:
- Manage options without '=' in PostgreSQL configuration files
- Preserve Timeline history files (Fixes: #70)
- Workaround for rsync on SUSE Linux (Closes: #13 and #26)
- Disables dangerous settings in postgresql.auto.conf
(Closes: #68)
Version 1.4.1 - 05 May 2015
* Fix for WAL archival stop working if first backup is EMPTY
(Closes: #64)
* Fix exception during error handling in Barman recovery
(Closes: #65)
* After a backup, limit cron activity to WAL archiving only
(Closes: #62)
* Improved robustness and error reporting of the backup delete
command (Closes: #63)
* Fix computation of WAL production ratio as reported in the
show-backup command
* Improved management of xlogdb file, which is now correctly fsynced
when updated. Also, the rebuild-xlogdb command now operates on a
temporary new file, which overwrites the main one when finished.
* Add unit tests for dateutil module compatibility
* Modified Barman version following PEP 440 rules and added support
of tests in Python 3.4
Version 1.4.0 - 26 Jan 2015
* Incremental base backup implementation through the reuse_backup
global/server option. Possible values are off (disabled,
default), copy (preventing unmodified files from being
transferred) and link (allowing for deduplication through hard
links).
* Store and show deduplication effects when using reuse_backup=
link.
* Added transparent support of pg_stat_archiver (PostgreSQL 9.4) in
check, show-server and status commands.
* Improved administration by invoking WAL maintenance at the end of
a successful backup.
* Changed the way unused WAL files are trashed, by differentiating
between concurrent and exclusive backup cases.
* Improved performance of WAL statistics calculation.
* Treat a missing pg_ident.conf as a WARNING rather than an error.
* Refactored output layer by removing remaining yield calls.
* Check that rsync is in the system path.
* Include history files in WAL management.
* Improved robustness through more unit tests.
* Fixed bug #55: Ignore fsync EINVAL errors on directories.
* Fixed bug #58: retention policies delete.
Version 1.3.3 - 21 Aug 2014
* Added "last_backup_max_age", a new global/server option that
allows administrators to set the max age of the last backup in a
catalogue, making it easier to detect any issues with periodical
backup execution
* Improved robustness of "barman backup" by introducing two global/
server options: "basebackup_retry_times" and
"basebackup_retry_sleep". These options allow an administrator to
specify, respectively, the number of attempts for a copy
operation after a failure, and the number of seconds of wait
before retrying
* Improved the recovery process via rsync on an existing directory
(incremental recovery), by splitting the previous rsync call into
several ones - invoking checksum control only when necessary
* Added support for PostgreSQL 8.3
* Minor changes:
+ Support for comma separated list values configuration options
+ Improved backup durability by calling fsync() on backup and
WAL files during "barman backup" and "barman cron"
+ Improved Nagios output for "barman check --nagios"
+ Display compression ratio for WALs in "barman show-backup"
+ Correctly handled keyboard interruption (CTRL-C) while
performing barman backup
+ Improved error messages of failures regarding the stop of a
backup
+ Wider coverage of unit tests
* Bug fixes:
+ Copies "recovery.conf" on the remote server during "barman
recover" (#45)
+ Correctly detect pre/post archive hook scripts (#41)
Version 1.3.2 - 15 Apr 2014
* Fixed incompatibility with PostgreSQL 8.4 (Closes #40, bug
introduced in version 1.3.1)
Version 1.3.1 - 14 Apr 2014
* Added support for concurrent backup of PostgreSQL 9.2 and 9.3
servers that use the "pgespresso" extension. This feature is
controlled by the "backup_options" configuration option (global/
server) and activated when set to "concurrent_backup". Concurrent
backup allows DBAs to perform full backup operations from a
streaming replicated standby.
* Added the "barman diagnose" command which prints important
information about the Barman system (extremely useful for support
and problem solving)
* Improved error messages and exception handling interface
* Fixed bug in recovery of tablespaces that are created inside the
PGDATA directory (bug introduced in version 1.3.0)
* Fixed minor bug of unhandled -q option, for quiet mode of
commands to be used in cron jobs (bug introduced in version
1.3.0)
* Minor bug fixes and code refactoring
Version 1.3.0 - 3 Feb 2014
* Refactored BackupInfo class for backup metadata to use the new
FieldListFile class (infofile module)
* Refactored output layer to use a dedicated module, in order to
facilitate integration with Nagios (NagiosOutputWriter class)
* Refactored subprocess handling in order to isolate stdin/stderr/
stdout channels (command_wrappers module)
* Refactored hook scripts management
* Extracted logging configuration and userid enforcement from the
configuration class.
* Support for hook scripts to be executed before and after a WAL
file is archived, through the 'pre_archive_script' and
'post_archive_script' configuration options.
* Implemented immediate checkpoint capability with
--immediate-checkpoint command option and 'immediate_checkpoint'
configuration option
* Implemented network compression for remote backup and recovery
through the 'network_compression' configuration option (#19)
* Implemented the 'rebuild-xlogdb' command (Closes #27 and #28)
* Added deduplication of tablespaces located inside the PGDATA
directory
* Refactored remote recovery code to work the same way local
recovery does, by performing remote directory preparation
(assuming the remote user has the right permissions on the remote
server)
* 'barman backup' now tries and create server directories before
attempting to execute a full backup (#14)
* Fixed bug #22: improved documentation for tablespaces relocation
* Fixed bug #31: 'barman cron' checks directory permissions for
lock file
* Fixed bug #32: xlog.db read access during cron activities
Version 1.2.3 - 5 September 2013
* Added support for PostgreSQL 9.3
* Added support for the "--target-name" recovery option, which allows to
restore to a named point previously specified with pg_create_restore_point
(only for PostgreSQL 9.1 and above users)
* Fixed bug #27 about flock() usage with barman.lockfile (many thanks to
Damon Snyder )
* Introduced Python 3 compatibility
Version 1.2.2 - 24 June 2013
* Fix python 2.6 compatibility
Version 1.2.1 - 17 June 2013
* Added the "bandwidth_limit" global/server option which allows
to limit the I/O bandwidth (in KBPS) for backup and recovery operations
* Added the "tablespace_bandwidth_limit" global/server option which allows
to limit the I/O bandwidth (in KBPS) for backup and recovery operations
on a per tablespace basis
* Added /etc/barman/barman.conf as default location
* Bug fix: avoid triggering the minimum_redundancy check
on FAILED backups (thanks to Jérôme Vanandruel)
Version 1.2.0 - 31 Jan 2013
* Added the "retention_policy_mode" global/server option which defines
the method for enforcing retention policies (currently only "auto")
* Added the "minimum_redundancy" global/server option which defines
the minimum number of backups to be kept for a server
* Added the "retention_policy" global/server option which defines
retention policies management based on redundancy (e.g. REDUNDANCY 4)
or recovery window (e.g. RECOVERY WINDOW OF 3 MONTHS)
* Added retention policy support to the logging infrastructure, the
"check" and the "status" commands
* The "check" command now integrates minimum redundancy control
* Added retention policy states (valid, obsolete and potentially obsolete)
to "show-backup" and "list-backup" commands
* The 'all' keyword is now forbidden as server name
* Added basic support for Nagios plugin output to the 'check'
command through the --nagios option
* Barman now requires argh => 0.21.2 and argcomplete-
* Minor bug fixes
Version 1.1.2 - 29 Nov 2012
* Added "configuration_files_directory" option that allows
to include multiple server configuration files from a directory
* Support for special backup IDs: latest, last, oldest, first
* Management of multiple servers to the 'list-backup' command.
'barman list-backup all' now list backups for all the configured servers.
* Added "application_name" management for PostgreSQL >= 9.0
* Fixed bug #18: ignore missing WAL files if not found during delete
Version 1.1.1 - 16 Oct 2012
* Fix regressions in recover command.
Version 1.1.0 - 12 Oct 2012
* Support for hook scripts to be executed before and after
a 'backup' command through the 'pre_backup_script' and 'post_backup_script'
configuration options.
* Management of multiple servers to the 'backup' command.
'barman backup all' now iteratively backs up all the configured servers.
* Fixed bug #9: "9.2 issue with pg_tablespace_location()"
* Add warning in recovery when file location options have been defined
in the postgresql.conf file (issue #10)
* Fail fast on recover command if the destination directory contains
the ':' character (Closes: #4) or if an invalid tablespace
relocation rule is passed
* Report an informative message when pg_start_backup() invocation
fails because an exclusive backup is already running (Closes: #8)
Version 1.0.0 - 6 July 2012
* Backup of multiple PostgreSQL servers, with different versions. Versions
from PostgreSQL 8.4+ are supported.
* Support for secure remote backup (through SSH)
* Management of a catalog of backups for every server, allowing users
to easily create new backups, delete old ones or restore them
* Compression of WAL files that can be configured on a per server
basis using compression/decompression filters, both predefined (gzip
and bzip2) or custom
* Support for INI configuration file with global and per-server directives.
Default location for configuration files are /etc/barman.conf or
~/.barman.conf. The '-c' option allows users to specify a different one
* Simple indexing of base backups and WAL segments that does not require
a local database
* Maintenance mode (invoked through the 'cron' command) which performs
ordinary operations such as WAL archival and compression, catalog
updates, etc.
* Added the 'backup' command which takes a full physical base backup
of the given PostgreSQL server configured in Barman
* Added the 'recover' command which performs local recovery of a given
backup, allowing DBAs to specify a point in time. The 'recover' command
supports relocation of both the PGDATA directory and, where applicable,
the tablespaces
* Added the '--remote-ssh-command' option to the 'recover' command for
remote recovery of a backup. Remote recovery does not currently support
relocation of tablespaces
* Added the 'list-server' command that lists all the active servers
that have been configured in barman
* Added the 'show-server' command that shows the relevant information
for a given server, including all configuration options
* Added the 'status' command which shows information about the current
state of a server, including Postgres version, current transaction ID,
archive command, etc.
* Added the 'check' command which returns 0 if everything Barman needs
is functioning correctly
* Added the 'list-backup' command that lists all the available backups
for a given server, including size of the base backup and total size
of the related WAL segments
* Added the 'show-backup' command that shows the relevant information
for a given backup, including time of start, size, number of related
WAL segments and their size, etc.
* Added the 'delete' command which removes a backup from the catalog
* Added the 'list-files' command which lists all the files for a
single backup
* RPM Package for RHEL 5/6
barman-2.18/AUTHORS 0000644 0006212 0006212 00000002353 14172556763 012153 0 ustar 0000000 0000000 Barman maintainers (in alphabetical order):
* Abhijit Menon-Sen
* Didier Michel
* Jane Threefoot
* Michael Wallace
Past contributors (in alphabetical order):
* Anna Bellandi (QA/testing)
* Britt Cole (documentation reviewer)
* Carlo Ascani (developer)
* Francesco Canovai (QA/testing)
* Gabriele Bartolini (architect)
* Gianni Ciolli (QA/testing)
* Giulio Calacoci (developer)
* Giuseppe Broccolo (developer)
* Jonathan Battiato (QA/testing)
* Leonardo Cecchi (developer)
* Marco Nenciarini (project leader)
* Niccolò Fei (QA/testing)
* Rubens Souza (QA/testing)
* Stefano Bianucci (developer)
Many thanks go to our sponsors (in alphabetical order):
* 4Caast - http://4caast.morfeo-project.org/ (Founding sponsor)
* Adyen - http://www.adyen.com/
* Agile Business Group - http://www.agilebg.com/
* BIJ12 - http://www.bij12.nl/
* CSI Piemonte - http://www.csipiemonte.it/ (Founding sponsor)
* Ecometer - http://www.ecometer.it/
* GestionaleAuto - http://www.gestionaleauto.com/ (Founding sponsor)
* Jobrapido - http://www.jobrapido.com/
* Navionics - http://www.navionics.com/ (Founding sponsor)
* Sovon Vogelonderzoek Nederland - https://www.sovon.nl/
* Subito.it - http://www.subito.it/
* XCon Internet Services - http://www.xcon.it/ (Founding sponsor)
barman-2.18/doc/ 0000755 0006212 0006212 00000000000 14172556766 011650 5 ustar 0000000 0000000 barman-2.18/doc/.gitignore 0000644 0006212 0006212 00000000057 14172556763 013637 0 ustar 0000000 0000000 barman-tutorial.en.pdf
barman-tutorial.en.html
barman-2.18/doc/barman-cloud-wal-restore.1.md 0000644 0006212 0006212 00000006761 14172556763 017146 0 ustar 0000000 0000000 % BARMAN-CLOUD-WAL-RESTORE(1) Barman User manuals | Version 2.18
% EnterpriseDB
% January 21, 2022
# NAME
barman-cloud-wal-restore - Restore PostgreSQL WAL files from the Cloud using `restore_command`
# SYNOPSIS
barman-cloud-wal-restore [*OPTIONS*] *SOURCE_URL* *SERVER_NAME* *WAL_NAME* *WAL_PATH*
# DESCRIPTION
This script can be used as a `restore_command` to download WAL files
previously archived with `barman-cloud-wal-archive` command.
Currently AWS S3 and Azure Blob Storage are supported.
This script and Barman are administration tools for disaster recovery
of PostgreSQL servers written in Python and maintained by EnterpriseDB.
# POSITIONAL ARGUMENTS
SOURCE_URL
: URL of the cloud source, such as a bucket in AWS S3.
For example: `s3://BUCKET_NAME/path/to/folder` (where `BUCKET_NAME`
is the bucket you have created in AWS).
SERVER_NAME
: the name of the server as configured in Barman.
WAL_NAME
: the name of the WAL file, equivalent of '%f' keyword (according to 'restore_command').
WAL_PATH
: the value of the '%p' keyword (according to 'restore_command').
# OPTIONS
-h, --help
: show a help message and exit
-V, --version
: show program's version number and exit
-v, --verbose
: increase output verbosity (e.g., -vv is more than -v)
-q, --quiet
: decrease output verbosity (e.g., -qq is less than -q)
-t, --test
: test connectivity to the cloud destination and exit
--cloud-provider {aws-s3,azure-blob-storage}
: the cloud provider to which the backup should be uploaded
-P, --profile
: profile name (e.g. INI section in AWS credentials file)
--endpoint-url
: override the default S3 URL construction mechanism by specifying an endpoint.
--credential {azure-cli,managed-identity}
: optionally specify the type of credential to use when authenticating with
Azure Blob Storage. If omitted then the credential will be obtained from the
environment. If no credentials can be found in the environment then the default
Azure authentication flow will be used.
# REFERENCES
For Boto:
* https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html
For AWS:
* http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-set-up.html
* http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html.
For Azure Blob Storage:
* https://docs.microsoft.com/en-us/azure/storage/blobs/authorize-data-operations-cli#set-environment-variables-for-authorization-parameters
* https://docs.microsoft.com/en-us/python/api/azure-storage-blob/?view=azure-python
# DEPENDENCIES
If using `--cloud-provider=aws-s3`:
* boto3
If using `--cloud-provider=azure-blob-storage`:
* azure-storage-blob
* azure-identity (optional, if you wish to use DefaultAzureCredential)
# EXIT STATUS
0
: Success
1
: The requested WAL could not be found
2
: The connection to the cloud provider failed
3
: There was an error in the command input
Other non-zero codes
: Failure
# BUGS
Barman has been extensively tested, and is currently being used in several
production environments. However, we cannot exclude the presence of bugs.
Any bug can be reported via the Github issue tracker.
# RESOURCES
* Homepage:
* Documentation:
* Professional support:
# COPYING
Barman is the property of EnterpriseDB UK Limited
and its code is distributed under GNU General Public License v3.
© Copyright EnterpriseDB UK Limited 2011-2022
barman-2.18/doc/Makefile 0000644 0006212 0006212 00000004207 14172556763 013310 0 ustar 0000000 0000000 MANPAGES=barman.1 barman.5 \
barman-wal-archive.1 barman-wal-restore.1 \
barman-cloud-backup.1 \
barman-cloud-backup-delete.1 \
barman-cloud-backup-keep.1 \
barman-cloud-backup-list.1 \
barman-cloud-check-wal-archive.1 \
barman-cloud-wal-archive.1 \
barman-cloud-restore.1 \
barman-cloud-wal-restore.1
SUBDIRS=manual
# Detect the pandoc major version (1 or 2)
PANDOC_VERSION = $(shell pandoc --version | awk -F '[ .]+' '/^pandoc/{print $$2; exit}')
ifeq ($(PANDOC_VERSION),1)
SMART = --smart
NOSMART_SUFFIX =
else
SMART =
NOSMART_SUFFIX = -smart
endif
all: $(MANPAGES) $(SUBDIRS)
barman.1: $(sort $(wildcard barman.1.d/??-*.md))
pandoc -s -f markdown$(NOSMART_SUFFIX) -t man -o $@ $^
barman.5: $(sort $(wildcard barman.5.d/??-*.md))
pandoc -s -f markdown$(NOSMART_SUFFIX) -t man -o $@ $^
barman-wal-archive.1: barman-wal-archive.1.md
pandoc -s -f markdown$(NOSMART_SUFFIX) -t man -o $@ $<
barman-wal-restore.1: barman-wal-restore.1.md
pandoc -s -f markdown$(NOSMART_SUFFIX) -t man -o $@ $<
barman-cloud-backup.1: barman-cloud-backup.1.md
pandoc -s -f markdown$(nosmart_suffix) -t man -o $@ $<
barman-cloud-backup-delete.1: barman-cloud-backup-delete.1.md
pandoc -s -f markdown$(nosmart_suffix) -t man -o $@ $<
barman-cloud-backup-keep.1: barman-cloud-backup-keep.1.md
pandoc -s -f markdown$(nosmart_suffix) -t man -o $@ $<
barman-cloud-backup-list.1: barman-cloud-backup-list.1.md
pandoc -s -f markdown$(nosmart_suffix) -t man -o $@ $<
barman-cloud-check-wal-archive.1: barman-cloud-check-wal-archive.1.md
pandoc -s -f markdown$(nosmart_suffix) -t man -o $@ $<
barman-cloud-restore.1: barman-cloud-restore.1.md
pandoc -s -f markdown$(nosmart_suffix) -t man -o $@ $<
barman-cloud-wal-archive.1: barman-cloud-wal-archive.1.md
pandoc -s -f markdown$(nosmart_suffix) -t man -o $@ $<
barman-cloud-wal-restore.1: barman-cloud-wal-restore.1.md
pandoc -s -f markdown$(nosmart_suffix) -t man -o $@ $<
clean:
rm -f $(MANPAGES)
for dir in $(SUBDIRS); do \
$(MAKE) -C $$dir clean; \
done
help:
@echo "Usage:"
@echo " $$ make"
subdirs: $(SUBDIRS)
$(SUBDIRS):
$(MAKE) -C $@
.PHONY: all clean help subdirs $(SUBDIRS)
barman-2.18/doc/barman-wal-archive.1 0000644 0006212 0006212 00000004743 14172556763 015377 0 ustar 0000000 0000000 .\" Automatically generated by Pandoc 2.2.1
.\"
.TH "BARMAN\-WAL\-ARCHIVE" "1" "January 21, 2022" "Barman User manuals" "Version 2.18"
.hy
.SH NAME
.PP
barman\-wal\-archive \- \f[C]archive_command\f[] based on Barman\[aq]s
put\-wal
.SH SYNOPSIS
.PP
barman\-wal\-archive [\f[I]OPTIONS\f[]] \f[I]BARMAN_HOST\f[]
\f[I]SERVER_NAME\f[] \f[I]WAL_PATH\f[]
.SH DESCRIPTION
.PP
This script can be used in the \f[C]archive_command\f[] of a PostgreSQL
server to ship WAL files to a Barman host using the \[aq]put\-wal\[aq]
command (introduced in Barman 2.6).
An SSH connection will be opened to the Barman host.
\f[C]barman\-wal\-archive\f[] allows the integration of Barman in
PostgreSQL clusters for better business continuity results.
.PP
This script and Barman are administration tools for disaster recovery of
PostgreSQL servers written in Python and maintained by EnterpriseDB.
.SH POSITIONAL ARGUMENTS
.TP
.B BARMAN_HOST
the host of the Barman server.
.RS
.RE
.TP
.B SERVER_NAME
the server name configured in Barman from which WALs are taken.
.RS
.RE
.TP
.B WAL_PATH
the value of the \[aq]%p\[aq] keyword (according to
\[aq]archive_command\[aq]).
.RS
.RE
.SH OPTIONS
.TP
.B \-h, \-\-help
show a help message and exit
.RS
.RE
.TP
.B \-V, \-\-version
show program\[aq]s version number and exit
.RS
.RE
.TP
.B \-U \f[I]USER\f[], \-\-user \f[I]USER\f[]
the user used for the ssh connection to the Barman server.
Defaults to \[aq]barman\[aq].
.RS
.RE
.TP
.B \-c \f[I]CONFIG\f[], \-\-config \f[I]CONFIG\f[]
configuration file on the Barman server
.RS
.RE
.TP
.B \-t, \-\-test
test both the connection and the configuration of the requested
PostgreSQL server in Barman for WAL retrieval.
With this option, the \[aq]WAL_PATH\[aq] mandatory argument is ignored.
.RS
.RE
.SH EXIT STATUS
.TP
.B 0
Success
.RS
.RE
.TP
.B Not zero
Failure
.RS
.RE
.SH SEE ALSO
.PP
\f[C]barman\f[] (1), \f[C]barman\f[] (5).
.SH BUGS
.PP
Barman has been extensively tested, and is currently being used in
several production environments.
However, we cannot exclude the presence of bugs.
.PP
Any bug can be reported via the Github issue tracker.
.SH RESOURCES
.IP \[bu] 2
Homepage:
.IP \[bu] 2
Documentation:
.IP \[bu] 2
Professional support:
.SH COPYING
.PP
Barman is the property of EnterpriseDB UK Limited and its code is
distributed under GNU General Public License v3.
.PP
© Copyright EnterpriseDB UK Limited 2011\-2022
.SH AUTHORS
EnterpriseDB .
barman-2.18/doc/barman-cloud-wal-archive.1.md 0000644 0006212 0006212 00000013714 14172556763 017100 0 ustar 0000000 0000000 % BARMAN-CLOUD-WAL-ARCHIVE(1) Barman User manuals | Version 2.18
% EnterpriseDB
% January 21, 2022
# NAME
barman-cloud-wal-archive - Archive PostgreSQL WAL files in the Cloud using `archive_command`
# SYNOPSIS
barman-cloud-wal-archive [*OPTIONS*] *DESTINATION_URL* *SERVER_NAME* *WAL_PATH*
# DESCRIPTION
This script can be used in the `archive_command` of a PostgreSQL
server to ship WAL files to the Cloud. Currently AWS S3 and Azure Blob
Storage are supported.
Note: If you are running python 2 or older unsupported versions of
python 3 then avoid the compression options `--gzip` or `--bzip2` as
barman-cloud-wal-restore is unable to restore gzip-compressed WALs
on python < 3.2 or bzip2-compressed WALs on python < 3.3.
This script and Barman are administration tools for disaster recovery
of PostgreSQL servers written in Python and maintained by EnterpriseDB.
# POSITIONAL ARGUMENTS
DESTINATION_URL
: URL of the cloud destination, such as a bucket in AWS S3.
For example: `s3://BUCKET_NAME/path/to/folder` (where `BUCKET_NAME`
is the bucket you have created in AWS).
SERVER_NAME
: the name of the server as configured in Barman.
WAL_PATH
: the value of the '%p' keyword (according to 'archive_command').
# OPTIONS
-h, --help
: show a help message and exit
-V, --version
: show program's version number and exit
-v, --verbose
: increase output verbosity (e.g., -vv is more than -v)
-q, --quiet
: decrease output verbosity (e.g., -qq is less than -q)
-t, --test
: test connectivity to the cloud destination and exit
-z, --gzip
: gzip-compress the WAL while uploading to the cloud
(should not be used with python < 3.2)
-j, --bzip2
: bzip2-compress the WAL while uploading to the cloud
(should not be used with python < 3.3)
--snappy
: snappy-compress the WAL while uploading to the cloud
(requires optional python-snappy library and should not be
used with python < 3.3)
--cloud-provider {aws-s3,azure-blob-storage}
: the cloud provider to which the backup should be uploaded
--tags KEY1,VALUE1 KEY2,VALUE2 ...
: A space-separated list of comma-separated key-value pairs representing tags
to be added to each WAL file archived to cloud storage.
--history-tags KEY1,VALUE1 KEY2,VALUE2 ...
: A space-separated list of comma-separated key-value pairs representing tags
to be added to each history file archived to cloud storage.
If this is provided alongside the `--tags` option then the value of
`--history-tags` will be used in place of `--tags` for history files.
All other WAL files will continue to be tagged with the value of `--tags`.
-P, --profile
: profile name (e.g. INI section in AWS credentials file)
--endpoint-url
: override the default S3 URL construction mechanism by specifying an endpoint.
-e, --encryption
: the encryption algorithm used when storing the uploaded data in S3
Allowed values: 'AES256'|'aws:kms'
--encryption-scope
: the name of an encryption scope defined in the Azure Blob Storage
service which is to be used to encrypt the data in Azure
--credential {azure-cli,managed-identity}
: optionally specify the type of credential to use when authenticating with
Azure Blob Storage. If omitted then the credential will be obtained from the
environment. If no credentials can be found in the environment then the default
Azure authentication flow will be used.
--max-block-size SIZE
: the chunk size to be used when uploading an object to Azure Blob Storage via the
concurrent chunk method (default: 4MB).
--max-concurrency CONCURRENCY
: the maximum number of chunks to be uploaded concurrently to Azure Blob Storage
(default: 1). Whether the maximum concurrency is achieved depends on the values
of --max-block-size (should be less than or equal to
`WAL segment size after compression / max_concurrency`) and --max-single-put-size
(must be less than WAL segment size after compression).
--max-single-put-size SIZE
: maximum size for which the Azure client will upload an object to Azure Blob
Storage in a single request (default: 64MB). If this is set lower than the
WAL segment size after any applied compression then the concurrent chunk upload
method for WAL archiving will be used.
# REFERENCES
For Boto:
* https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html
For AWS:
* http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-set-up.html
* http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html.
For Azure Blob Storage:
* https://docs.microsoft.com/en-us/azure/storage/blobs/authorize-data-operations-cli#set-environment-variables-for-authorization-parameters
* https://docs.microsoft.com/en-us/python/api/azure-storage-blob/?view=azure-python
# DEPENDENCIES
If using `--cloud-provider=aws-s3`:
* boto3
If using `--cloud-provider=azure-blob-storage`:
* azure-storage-blob
* azure-identity (optional, if you wish to use DefaultAzureCredential)
# EXIT STATUS
0
: Success
1
: The WAL archive operation was not successful
2
: The connection to the cloud provider failed
3
: There was an error in the command input
Other non-zero codes
: Failure
# SEE ALSO
This script can be used in conjunction with `pre_archive_retry_script` to relay WAL
files to S3, as follows:
```
pre_archive_retry_script = 'barman-cloud-wal-archive [*OPTIONS*] *DESTINATION_URL* ${BARMAN_SERVER}'
```
# BUGS
Barman has been extensively tested, and is currently being used in several
production environments. However, we cannot exclude the presence of bugs.
Any bug can be reported via the Github issue tracker.
# RESOURCES
* Homepage:
* Documentation:
* Professional support:
# COPYING
Barman is the property of EnterpriseDB UK Limited
and its code is distributed under GNU General Public License v3.
© Copyright EnterpriseDB UK Limited 2011-2022
barman-2.18/doc/barman.conf 0000644 0006212 0006212 00000006655 14172556763 013770 0 ustar 0000000 0000000 ; Barman, Backup and Recovery Manager for PostgreSQL
; http://www.pgbarman.org/ - http://www.enterprisedb.com/
;
; Main configuration file
[barman]
; System user
barman_user = barman
; Directory of configuration files. Place your sections in separate files with .conf extension
; For example place the 'main' server section in /etc/barman.d/main.conf
configuration_files_directory = /etc/barman.d
; Main directory
barman_home = /var/lib/barman
; Locks directory - default: %(barman_home)s
;barman_lock_directory = /var/run/barman
; Log location
log_file = /var/log/barman/barman.log
; Log level (see https://docs.python.org/3/library/logging.html#levels)
log_level = INFO
; Default compression level: possible values are None (default), bzip2, gzip, pigz, pygzip or pybzip2
;compression = gzip
; Pre/post backup hook scripts
;pre_backup_script = env | grep ^BARMAN
;pre_backup_retry_script = env | grep ^BARMAN
;post_backup_retry_script = env | grep ^BARMAN
;post_backup_script = env | grep ^BARMAN
; Pre/post archive hook scripts
;pre_archive_script = env | grep ^BARMAN
;pre_archive_retry_script = env | grep ^BARMAN
;post_archive_retry_script = env | grep ^BARMAN
;post_archive_script = env | grep ^BARMAN
; Pre/post delete scripts
;pre_delete_script = env | grep ^BARMAN
;pre_delete_retry_script = env | grep ^BARMAN
;post_delete_retry_script = env | grep ^BARMAN
;post_delete_script = env | grep ^BARMAN
; Pre/post wal delete scripts
;pre_wal_delete_script = env | grep ^BARMAN
;pre_wal_delete_retry_script = env | grep ^BARMAN
;post_wal_delete_retry_script = env | grep ^BARMAN
;post_wal_delete_script = env | grep ^BARMAN
; Global bandwidth limit in kilobytes per second - default 0 (meaning no limit)
;bandwidth_limit = 4000
; Number of parallel jobs for backup and recovery via rsync (default 1)
;parallel_jobs = 1
; Immediate checkpoint for backup command - default false
;immediate_checkpoint = false
; Enable network compression for data transfers - default false
;network_compression = false
; Number of retries of data copy during base backup after an error - default 0
;basebackup_retry_times = 0
; Number of seconds of wait after a failed copy, before retrying - default 30
;basebackup_retry_sleep = 30
; Maximum execution time, in seconds, per server
; for a barman check command - default 30
;check_timeout = 30
; Time frame that must contain the latest backup date.
; If the latest backup is older than the time frame, barman check
; command will report an error to the user.
; If empty, the latest backup is always considered valid.
; Syntax for this option is: "i (DAYS | WEEKS | MONTHS | HOURS)" where i is an
; integer > 0 which identifies the number of days | weeks | months of
; validity of the latest backup for this check. Also known as 'smelly backup'.
;last_backup_maximum_age =
; Time frame that must contain the latest WAL file
; If the latest WAL file is older than the time frame, barman check
; command will report an error to the user.
; Syntax for this option is: "i (DAYS | WEEKS | MONTHS | HOURS)" where i is an
; integer > 0
;last_wal_maximum_age =
; Minimum number of required backups (redundancy)
;minimum_redundancy = 1
; Global retention policy (REDUNDANCY or RECOVERY WINDOW)
; Examples of retention policies
; Retention policy (disabled, default)
;retention_policy =
; Retention policy (based on redundancy)
;retention_policy = REDUNDANCY 2
; Retention policy (based on recovery window)
;retention_policy = RECOVERY WINDOW OF 4 WEEKS
barman-2.18/doc/manual/ 0000755 0006212 0006212 00000000000 14172556766 013125 5 ustar 0000000 0000000 barman-2.18/doc/manual/.gitignore 0000644 0006212 0006212 00000000053 14172556763 015110 0 ustar 0000000 0000000 barman-manual.en.html
barman-manual.en.pdf
barman-2.18/doc/manual/23-wal_streaming.en.md 0000644 0006212 0006212 00000012343 14172556763 017126 0 ustar 0000000 0000000 ## WAL streaming
Barman can reduce the Recovery Point Objective (RPO) by allowing users
to add continuous WAL streaming from a PostgreSQL server, on top of
the standard `archive_command` strategy.
Barman relies on [`pg_receivewal`][25], a utility that has been
available from PostgreSQL 9.2 which exploits the native streaming
replication protocol and continuously receives transaction logs from a
PostgreSQL server (master or standby).
Prior to PostgreSQL 10, `pg_receivewal` was named `pg_receivexlog`.
> **IMPORTANT:**
> Barman requires that `pg_receivewal` is installed on the same
> server. For PostgreSQL 9.2 servers, you need `pg_receivexlog` of
> version 9.2 installed alongside Barman. For PostgreSQL 9.3 and
> above, it is recommended to install the latest available version of
> `pg_receivewal`, as it is back compatible. Otherwise, users can
> install multiple versions of `pg_receivewal`/`pg_receivexlog` on the Barman server
> and properly point to the specific version for a server, using the
> `path_prefix` option in the configuration file.
In order to enable streaming of transaction logs, you need to:
1. setup a streaming connection as previously described
2. set the `streaming_archiver` option to `on`
The `cron` command, if the aforementioned requirements are met,
transparently manages log streaming through the execution of the
`receive-wal` command. This is the recommended scenario.
However, users can manually execute the `receive-wal` command:
``` bash
barman receive-wal
```
> **NOTE:**
> The `receive-wal` command is a foreground process.
Transaction logs are streamed directly in the directory specified by the
`streaming_wals_directory` configuration option and are then archived
by the `archive-wal` command.
Unless otherwise specified in the `streaming_archiver_name` parameter,
and only for PostgreSQL 9.3 or above, Barman will set `application_name`
of the WAL streamer process to `barman_receive_wal`, allowing you to
monitor its status in the `pg_stat_replication` system view of the
PostgreSQL server.
### Replication slots
> **IMPORTANT:** replication slots are available since PostgreSQL 9.4
Replication slots are an automated way to ensure that the PostgreSQL
server will not remove WAL files until they were received by all
archivers. Barman uses this mechanism to receive the transaction logs
from PostgreSQL.
You can find more information about replication slots in the
[PostgreSQL manual][replication-slots].
You can even base your backup architecture on streaming connection
only. This scenario is useful to configure Docker-based PostgreSQL
servers and even to work with PostgreSQL servers running on Windows.
> **IMPORTANT:**
> In this moment, the Windows support is still experimental, as it is
> not yet part of our continuous integration system.
### How to configure the WAL streaming
First, the PostgreSQL server must be configured to stream the
transaction log files to the Barman server.
To configure the streaming connection from Barman to the PostgreSQL
server you need to enable the `streaming_archiver`, as already said,
including this line in the server configuration file:
``` ini
streaming_archiver = on
```
If you plan to use replication slots (recommended),
another essential option for the setup of the streaming-based
transaction log archiving is the `slot_name` option:
``` ini
slot_name = barman
```
This option defines the name of the replication slot that will be
used by Barman. It is mandatory if you want to use replication slots.
When you configure the replication slot name, you can manually create a
replication slot for Barman with this command:
``` bash
barman@backup$ barman receive-wal --create-slot pg
Creating physical replication slot 'barman' on server 'pg'
Replication slot 'barman' created
```
Starting with Barman 2.10, you can configure Barman to automatically
create the replication slot by setting:
``` ini
create_slot = auto
```
### Limitations of partial WAL files with recovery
The standard behaviour of `pg_receivewal` is to write transactional
information in a file with `.partial` suffix after the WAL segment name.
Barman expects a partial file to be in the `streaming_wals_directory` of
a server. When completed, `pg_receivewal` removes the `.partial` suffix
and opens the following one, delivering the file to the `archive-wal` command
of Barman for permanent storage and compression.
In case of a sudden and unrecoverable failure of the master PostgreSQL server,
the `.partial` file that has been streamed to Barman contains very important
information that the standard archiver (through PostgreSQL's `archive_command`)
has not been able to deliver to Barman.
As of Barman 2.10, the `get-wal` command is able to return the content of
the current `.partial` WAL file through the `--partial/-P` option.
This is particularly useful in the case of recovery, both full or to a point
in time. Therefore, in case you run a `recover` command with `get-wal` enabled,
and without `--standby-mode`, Barman will automatically add the `-P` option
to `barman-wal-restore` (which will then relay that to the remote `get-wal`
command) in the `restore_command` recovery option.
`get-wal` will also search in the `incoming` directory, in case a WAL file
has already been shipped to Barman, but not yet archived.
barman-2.18/doc/manual/Makefile 0000644 0006212 0006212 00000001233 14172556763 014561 0 ustar 0000000 0000000 DOCS = barman-manual.en.pdf barman-manual.en.html
MDS = $(sort $(wildcard ??-*.en.md))
# Detect the pandoc major version (1 or 2)
PANDOC_VERSION = $(shell pandoc --version | awk -F '[ .]+' '/^pandoc/{print $$2; exit}')
ifeq ($(PANDOC_VERSION),1)
SMART = --smart
NOSMART_SUFFIX =
else
SMART =
NOSMART_SUFFIX = -smart
endif
all: $(DOCS)
barman-manual.en.pdf: $(MDS) ../images/*.png
pandoc -o $@ -s -f markdown$(NOSMART_SUFFIX) --toc $(MDS)
barman-manual.en.html: $(MDS) ../images/*.png
pandoc -o $@ -s -f markdown$(NOSMART_SUFFIX) --toc -t html5 $(MDS)
clean:
rm -f $(DOCS)
help:
@echo "Usage:"
@echo " $$ make"
.PHONY: all clean help
barman-2.18/doc/manual/50-feature-details.en.md 0000644 0006212 0006212 00000102753 14172556763 017355 0 ustar 0000000 0000000 \newpage
# Features in detail
In this section we present several Barman features and discuss their
applicability and the configuration required to use them.
This list is not exhaustive, as many scenarios can be created working
on the Barman configuration. Nevertheless, it is useful to discuss
common patterns.
## Backup features
### Incremental backup
Barman implements **file-level incremental backup**. Incremental
backup is a type of full periodic backup which only saves data changes
from the latest full backup available in the catalog for a specific
PostgreSQL server. It must not be confused with differential backup,
which is implemented by _WAL continuous archiving_.
> **NOTE:** Block level incremental backup will be available in
> future versions.
> **IMPORTANT:** The `reuse_backup` option can't be used with the
> `postgres` backup method at this time.
The main goals of incremental backups in Barman are:
- Reduce the time taken for the full backup process
- Reduce the disk space occupied by several periodic backups (**data
deduplication**)
This feature heavily relies on `rsync` and [hard links][8], which
must therefore be supported by both the underlying operating system
and the file system where the backup data resides.
The main concept is that a subsequent base backup will share those
files that have not changed since the previous backup, leading to
relevant savings in disk usage. This is particularly true of VLDB
contexts and of those databases containing a high percentage of
_read-only historical tables_.
Barman implements incremental backup through a global/server option
called `reuse_backup`, that transparently manages the `barman backup`
command. It accepts three values:
- `off`: standard full backup (default)
- `link`: incremental backup, by reusing the last backup for a server
and creating a hard link of the unchanged files (for backup space
and time reduction)
- `copy`: incremental backup, by reusing the last backup for a server
and creating a copy of the unchanged files (just for backup time
reduction)
The most common scenario is to set `reuse_backup` to `link`, as
follows:
``` ini
reuse_backup = link
```
Setting this at global level will automatically enable incremental
backup for all your servers.
As a final note, users can override the setting of the `reuse_backup`
option through the `--reuse-backup` runtime option for the `barman
backup` command. Similarly, the runtime option accepts three values:
`off`, `link` and `copy`. For example, you can run a one-off
incremental backup as follows:
``` bash
barman backup --reuse-backup=link
```
### Limiting bandwidth usage
It is possible to limit the usage of I/O bandwidth through the
`bandwidth_limit` option (global/per server), by specifying the
maximum number of kilobytes per second. By default it is set to 0,
meaning no limit.
> **IMPORTANT:** the `bandwidth_limit` option is supported with the
> `postgres` backup method for Postgres 9.4 and above, but the
> `tablespace_bandwidth_limit` option is available only if you use
> `rsync`
In case you have several tablespaces and you prefer to limit the I/O
workload of your backup procedures on one or more tablespaces, you can
use the `tablespace_bandwidth_limit` option (global/per server):
``` ini
tablespace_bandwidth_limit = tbname:bwlimit[, tbname:bwlimit, ...]
```
The option accepts a comma separated list of pairs made up of the
tablespace name and the bandwidth limit (in kilobytes per second).
When backing up a server, Barman will try and locate any existing
tablespace in the above option. If found, the specified bandwidth
limit will be enforced. If not, the default bandwidth limit for that
server will be applied.
### Network Compression
It is possible to reduce the size of transferred data using
compression. It can be enabled using the `network_compression` option
(global/per server):
> **IMPORTANT:** the `network_compression` option is not available
> with the `postgres` backup method.
``` ini
network_compression = true|false
```
Setting this option to `true` will enable data compression during
network transfers (for both backup and recovery). By default it is set
to `false`.
### Concurrent Backup and backup from a standby
Normally, during backup operations, Barman uses PostgreSQL native
functions `pg_start_backup` and `pg_stop_backup` for _exclusive
backup_. These operations are not allowed on a read-only standby
server.
Barman is also capable of performing backups of PostgreSQL from 9.2 or
greater database servers in a **concurrent way**, primarily through
the `backup_options` configuration parameter.[^ABOUT_CONCURRENT_BACKUP]
[^ABOUT_CONCURRENT_BACKUP]:
Concurrent backup is a technology that has been available in
PostgreSQL since version 9.2, through the _streaming replication
protocol_ (for example, using a tool like `pg_basebackup`).
This introduces a new architecture scenario with Barman: **backup from
a standby server**, using `rsync`.
> **IMPORTANT:** **Concurrent backup** requires users of PostgreSQL
> 9.2, 9.3, 9.4, and 9.5 to install the `pgespresso` open source
> extension on every PostgreSQL server of the cluster. For more
> detailed information and the source code, please visit the
> [pgespresso extension website][9]. Barman supports the new API
> introduced in PostgreSQL 9.6. This removes the requirement of the
> `pgespresso` extension to perform concurrent backups from this
> version of PostgreSQL.
By default, `backup_options` is transparently set to
`exclusive_backup` for backwards compatibility reasons.
Users of PostgreSQL 9.6 and later versions should set `backup_options`
to `concurrent_backup`.
> **IMPORTANT:** When PostgreSQL 9.5 is declared EOL by the Community,
> Barman will by default set `backup_options` to `concurrent_backup`.
> Support for `pgespresso` will be ceased then.
When `backup_options` is set to `concurrent_backup`, Barman activates
the _concurrent backup mode_ for a server and follows these two simple
rules:
- `ssh_command` must point to the destination Postgres server
- `conninfo` must point to a database on the destination Postgres
database. Using PostgreSQL 9.2, 9.3, 9.4, and 9.5, `pgespresso`
must be correctly installed through `CREATE EXTENSION`. Using 9.6 or
greater, concurrent backups are executed through the Postgres native
API (which requires an active connection from the start to the stop
of the backup).
> **IMPORTANT:** In case of a concurrent backup, currently Barman
> cannot determine whether the closing WAL file of a full backup has
> actually been shipped - opposite of an exclusive backup
> where PostgreSQL itself makes sure that the WAL file is correctly
> archived. Be aware that the full backup cannot be considered
> consistent until that WAL file has been received and archived by
> Barman. Barman 2.5 introduces a new state, called `WAITING_FOR_WALS`,
> which is managed by the `check-backup` command (part of the
> ordinary maintenance job performed by the `cron` command).
> From Barman 2.10, you can use the `--wait` option with `barman backup`
> command.
#### Current limitations on backup from standby
Barman currently requires that backup data (base backups and WAL files)
come from one server only. Therefore, in case of backup from a
standby, you should point to the standby server:
- `conninfo`
- `streaming_conninfo`, if you use `postgres` as `backup_method` and/or rely on WAL streaming
- `ssh_command`, if you use `rsync` as `backup_method`
> **IMPORTANT:** From Barman 2.8, backup from a standby is supported
> only for PostgreSQL 9.4 or higher (versions 9.4 and 9.5 require
> `pgespresso`). Support for 9.2 and 9.3 is deprecated.
The recommended and simplest way is to setup WAL streaming
with replication slots directly from the standby, which requires
PostgreSQL 9.4. This means:
* configure `streaming_archiver = on`, as described in the "WAL streaming"
section, including "Replication slots"
* disable `archiver = on`
Alternatively, from PostgreSQL 9.5 you can decide to archive from the
standby only using `archive_command` with `archive_mode = always` and
by disabling WAL streaming.
> **NOTE:** Unfortunately, it is not currently possible to enable both WAL archiving
> and streaming from the standby due to the way Barman performs WAL duplication
> checks and [an undocumented behaviours in all versions of PostgreSQL](https://www.postgresql.org/message-id/20170316170513.1429.77904@wrigleys.postgresql.org).
### Immediate checkpoint
Before starting a backup, Barman requests a checkpoint, which
generates additional workload. Normally that checkpoint is throttled
according to the settings for workload control on the PostgreSQL
server, which means that the backup could be delayed.
This default behaviour can be changed through the `immediate_checkpoint`
configuration global/server option (set to `false` by default).
If `immediate_checkpoint` is set to `true`, PostgreSQL will not try to
limit the workload, and the checkpoint will happen at maximum speed,
starting the backup as soon as possible.
At any time, you can override the configuration option behaviour, by
issuing `barman backup` with any of these two options:
- `--immediate-checkpoint`, which forces an immediate checkpoint;
- `--no-immediate-checkpoint`, which forces to wait for the checkpoint
to happen.
### Local backup
> **DISCLAIMER:** This feature is not recommended for production usage,
> as Barman and PostgreSQL reside on the same server and are part of
> the same single point of failure.
> Some EnterpriseDB customers have requested to add support for
> local backup to Barman to be used under specific circumstances
> and, most importantly, under the 24/7 production service delivered
> by the company. Using this feature currently requires installation
> from sources, or to customise the environment for the `postgres`
> user in terms of permissions as well as logging and cron configurations.
Under special circumstances, Barman can be installed on the same
server where the PostgreSQL instance resides, with backup data stored
on a separate volume from PGDATA and, where applicable, tablespaces.
Usually, these volumes reside on network storage appliances, with
filesystems like NFS.
This architecture is not endorsed by EnterpriseDB.
For an enhanced business continuity experience of PostgreSQL, with better
results in terms of RPO and RTO, EnterpriseDB still recommends the
shared nothing architecture with a remote installation of Barman, capable
of acting like a witness server for replication and monitoring purposes.
The only requirement for local backup is that Barman runs with the
same user as the PostgreSQL server, which is normally `postgres`.
Given that the Community packages by default install Barman under the `barman`
user, this use case requires manual installation procedures that include:
- cron configurations
- log configurations, including logrotate
In order to use local backup for a given server in Barman, you need to
set `backup_method` to `local-rsync`. The feature is essentially identical
to its `rsync` equivalent, which relies on SSH instead and operates remotely.
With `local-rsync` file system copy is performed issuing `rsync` commands locally
(for this reason it is required that Barman runs with the same user as PostgreSQL).
An excerpt of configuration for local backup for a server named `local-pg13` is:
```ini
[local-pg13]
description = "Local PostgreSQL 13"
backup_method = local-rsync
...
```
## Archiving features
### WAL compression
The `barman cron` command will compress WAL files if the `compression`
option is set in the configuration file. This option allows five
values:
- `bzip2`: for Bzip2 compression (requires the `bzip2` utility)
- `gzip`: for Gzip compression (requires the `gzip` utility)
- `pybzip2`: for Bzip2 compression (uses Python's internal compression module)
- `pygzip`: for Gzip compression (uses Python's internal compression module)
- `pigz`: for Pigz compression (requires the `pigz` utility)
- `custom`: for custom compression, which requires you to set the
following options as well:
- `custom_compression_filter`: a compression filter
- `custom_decompression_filter`: a decompression filter
- `custom_compression_magic`: a hex string to identify a custom compressed wal file
> *NOTE:* All methods but `pybzip2` and `pygzip` require `barman
> archive-wal` to fork a new process.
### Synchronous WAL streaming
> **IMPORTANT:** This feature is available only from PostgreSQL 9.5
> and above.
Barman can also reduce the Recovery Point Objective to zero, by
collecting the transaction WAL files like a synchronous standby server
would.
To configure such a scenario, the Barman server must be configured to
archive WALs via the [streaming connection](#postgresql-streaming-connection),
and the `receive-wal` process should figure as a synchronous standby
of the PostgreSQL server.
First of all, you need to retrieve the application name of the Barman
`receive-wal` process with the `show-servers` command:
``` bash
barman@backup$ barman show-servers pg|grep streaming_archiver_name
streaming_archiver_name: barman_receive_wal
```
Then the application name should be added to the `postgresql.conf`
file as a synchronous standby:
``` ini
synchronous_standby_names = 'barman_receive_wal'
```
> **IMPORTANT:** this is only an example of configuration, to show you that
> Barman is eligible to be a synchronous standby node.
> We are not suggesting to use ONLY Barman.
> You can read _["Synchronous Replication"][synch]_ from the PostgreSQL
> documentation for further information on this topic.
The PostgreSQL server needs to be restarted for the configuration to
be reloaded.
If the server has been configured correctly, the `replication-status`
command should show the `receive_wal` process as a synchronous
streaming client:
``` bash
[root@backup ~]# barman replication-status pg
Status of streaming clients for server 'pg':
Current xlog location on master: 0/9000098
Number of streaming clients: 1
1. #1 Sync WAL streamer
Application name: barman_receive_wal
Sync stage : 3/3 Remote write
Communication : TCP/IP
IP Address : 139.59.135.32 / Port: 58262 / Host: -
User name : streaming_barman
Current state : streaming (sync)
Replication slot: barman
WAL sender PID : 2501
Started at : 2016-09-16 10:33:01.725883+00:00
Sent location : 0/9000098 (diff: 0 B)
Write location : 0/9000098 (diff: 0 B)
Flush location : 0/9000098 (diff: 0 B)
```
## Catalog management features
### Minimum redundancy safety
You can define the minimum number of periodic backups for a PostgreSQL
server, using the global/per server configuration option called
`minimum_redundancy`, by default set to 0.
By setting this value to any number greater than 0, Barman makes sure
that at any time you will have at least that number of backups in a
server catalog.
This will protect you from accidental `barman delete` operations.
> **IMPORTANT:**
> Make sure that your retention policy settings do not collide with
> minimum redundancy requirements. Regularly check Barman's log for
> messages on this topic.
### Retention policies
Barman supports **retention policies** for backups.
A backup retention policy is a user-defined policy that determines how
long backups and related archive logs (Write Ahead Log segments) need
to be retained for recovery procedures.
Based on the user's request, Barman retains the periodic backups
required to satisfy the current retention policy and any archived WAL
files required for the complete recovery of those backups.
Barman users can define a retention policy in terms of **backup
redundancy** (how many periodic backups) or a **recovery window** (how
long).
Retention policy based on redundancy
: In a redundancy based retention policy, the user determines how
many periodic backups to keep. A redundancy-based retention policy
is contrasted with retention policies that use a recovery window.
Retention policy based on recovery window
: A recovery window is one type of Barman backup retention policy,
in which the DBA specifies a period of time and Barman ensures
retention of backups and/or archived WAL files required for
point-in-time recovery to any time during the recovery window. The
interval always ends with the current time and extends back in
time for the number of days specified by the user. For example, if
the retention policy is set for a recovery window of seven days,
and the current time is 9:30 AM on Friday, Barman retains the
backups required to allow point-in-time recovery back to 9:30 AM
on the previous Friday.
#### Scope
Retention policies can be defined for:
- **PostgreSQL periodic base backups**: through the `retention_policy`
configuration option
- **Archive logs**, for Point-In-Time-Recovery: through the
`wal_retention_policy` configuration option
> **IMPORTANT:**
> In a temporal dimension, archive logs must be included in the time
> window of periodic backups.
There are two typical use cases here: full or partial point-in-time
recovery.
Full point in time recovery scenario:
: Base backups and archive logs share the same retention policy,
allowing you to recover at any point in time from the first
available backup.
Partial point in time recovery scenario:
: Base backup retention policy is wider than that of archive logs,
for example allowing users to keep full, weekly backups of the
last 6 months, but archive logs for the last 4 weeks (granting to
recover at any point in time starting from the last 4 periodic
weekly backups).
> **IMPORTANT:**
> Currently, Barman implements only the **full point in time
> recovery** scenario, by constraining the `wal_retention_policy`
> option to `main`.
#### How they work
Retention policies in Barman can be:
- **automated**: enforced by `barman cron`
- **manual**: Barman simply reports obsolete backups and allows you
to delete them
> **IMPORTANT:**
> Currently Barman does not implement manual enforcement. This feature
> will be available in future versions.
#### Configuration and syntax
Retention policies can be defined through the following configuration
options:
- `retention_policy`: for base backup retention
- `wal_retention_policy`: for archive logs retention
- `retention_policy_mode`: can only be set to `auto` (retention
policies are automatically enforced by the `barman cron` command)
These configuration options can be defined both at a global level and
a server level, allowing users maximum flexibility on a multi-server
environment.
##### Syntax for `retention_policy`
The general syntax for a base backup retention policy through
`retention_policy` is the following:
``` ini
retention_policy = {REDUNDANCY value | RECOVERY WINDOW OF value {DAYS | WEEKS | MONTHS}}
```
Where:
- syntax is case insensitive
- `value` is an integer and is > 0
- in case of **redundancy retention policy**:
- `value` must be greater than or equal to the server minimum
redundancy level (if that value is not assigned,
a warning is generated)
- the first valid backup is the value-th backup in a reverse
ordered time series
- in case of **recovery window policy**:
- the point of recoverability is: current time - window
- the first valid backup is the first available backup before
the point of recoverability; its value in a reverse ordered
time series must be greater than or equal to the server
minimum redundancy level (if it is not assigned to that value
and a warning is generated)
By default, `retention_policy` is empty (no retention enforced).
##### Syntax for `wal_retention_policy`
Currently, the only allowed value for `wal_retention_policy` is the
special value `main`, that maps the retention policy of archive logs
to that of base backups.
## Hook scripts
Barman allows a database administrator to run hook scripts on these
two events:
- before and after a backup
- before and after the deletion of a backup
- before and after a WAL file is archived
- before and after a WAL file is deleted
There are two types of hook scripts that Barman can manage:
- standard hook scripts
- retry hook scripts
The only difference between these two types of hook scripts is that
Barman executes a standard hook script only once, without checking its
return code, whereas a retry hook script may be executed more than
once, depending on its return code.
Specifically, when executing a retry hook script, Barman checks the
return code and retries indefinitely until the script returns either
`SUCCESS` (with standard return code `0`), or `ABORT_CONTINUE` (return
code `62`), or `ABORT_STOP` (return code `63`). Barman treats any
other return code as a transient failure to be retried. Users are
given more power: a hook script can control its workflow by specifying
whether a failure is transient. Also, in case of a 'pre' hook script,
by returning `ABORT_STOP`, users can request Barman to interrupt the
main operation with a failure.
Hook scripts are executed in the following order:
1. The standard 'pre' hook script (if present)
2. The retry 'pre' hook script (if present)
3. The actual event (i.e. backup operation, or WAL archiving), if
retry 'pre' hook script was not aborted with `ABORT_STOP`
4. The retry 'post' hook script (if present)
5. The standard 'post' hook script (if present)
The output generated by any hook script is written in the log file of
Barman.
> **NOTE:**
> Currently, `ABORT_STOP` is ignored by retry 'post' hook scripts. In
> these cases, apart from logging an additional warning, `ABORT_STOP`
> will behave like `ABORT_CONTINUE`.
### Backup scripts
These scripts can be configured with the following global
configuration options (which can be overridden on a per server basis):
- `pre_backup_script`: _hook script_ executed _before_ a base backup,
only once, with no check on the exit code
- `pre_backup_retry_script`: _retry hook script_ executed _before_ a
base backup, repeatedly until success or abort
- `post_backup_retry_script`: _retry hook script_ executed _after_ a
base backup, repeatedly until success or abort
- `post_backup_script`: _hook script_ executed _after_ a base backup,
only once, with no check on the exit code
The script definition is passed to a shell and can return any exit
code. Only in case of a _retry_ script, Barman checks the return code
(see the [hook script section](#hook_scripts)).
The shell environment will contain the following variables:
- `BARMAN_BACKUP_DIR`: backup destination directory
- `BARMAN_BACKUP_ID`: ID of the backup
- `BARMAN_CONFIGURATION`: configuration file used by Barman
- `BARMAN_ERROR`: error message, if any (only for the `post` phase)
- `BARMAN_PHASE`: phase of the script, either `pre` or `post`
- `BARMAN_PREVIOUS_ID`: ID of the previous backup (if present)
- `BARMAN_RETRY`: `1` if it is a retry script, `0` if not
- `BARMAN_SERVER`: name of the server
- `BARMAN_STATUS`: status of the backup
- `BARMAN_VERSION`: version of Barman
### Backup delete scripts
Version **2.4** introduces pre and post backup delete scripts.
As previous scripts, backup delete scripts can be configured within global
configuration options, and it is possible to override them on a per server
basis:
- `pre_delete_script`: _hook script_ launched _before_ the deletion
of a backup, only once, with no check on the exit code
- `pre_delete_retry_script`: _retry hook script_ executed _before_
the deletion of a backup, repeatedly until success or abort
- `post_delete_retry_script`: _retry hook script_ executed _after_
the deletion of a backup, repeatedly until success or abort
- `post_delete_script`: _hook script_ launched _after_ the deletion
of a backup, only once, with no check on the exit code
The script is executed through a shell and can return any exit code.
Only in case of a _retry_ script, Barman checks the return code (see
the upper section).
Delete scripts uses the same environmental variables of a backup script,
plus:
- `BARMAN_NEXT_ID`: ID of the next backup (if present)
### WAL archive scripts
Similar to backup scripts, archive scripts can be configured with
global configuration options (which can be overridden on a per server
basis):
- `pre_archive_script`: _hook script_ executed _before_ a WAL file is
archived by maintenance (usually `barman cron`), only once, with no
check on the exit code
- `pre_archive_retry_script`: _retry hook script_ executed _before_ a
WAL file is archived by maintenance (usually `barman cron`),
repeatedly until it is successful or aborted
- `post_archive_retry_script`: _retry hook script_ executed _after_ a
WAL file is archived by maintenance, repeatedly until it is
successful or aborted
- `post_archive_script`: _hook script_ executed _after_ a WAL file is
archived by maintenance, only once, with no check on the exit code
The script is executed through a shell and can return any exit code.
Only in case of a _retry_ script, Barman checks the return code (see
the upper section).
Archive scripts share with backup scripts some environmental
variables:
- `BARMAN_CONFIGURATION`: configuration file used by Barman
- `BARMAN_ERROR`: error message, if any (only for the `post` phase)
- `BARMAN_PHASE`: phase of the script, either `pre` or `post`
- `BARMAN_SERVER`: name of the server
Following variables are specific to archive scripts:
- `BARMAN_SEGMENT`: name of the WAL file
- `BARMAN_FILE`: full path of the WAL file
- `BARMAN_SIZE`: size of the WAL file
- `BARMAN_TIMESTAMP`: WAL file timestamp
- `BARMAN_COMPRESSION`: type of compression used for the WAL file
### WAL delete scripts
Version **2.4** introduces pre and post WAL delete scripts.
Similarly to the other hook scripts, wal delete scripts can be
configured with global configuration options, and is possible to
override them on a per server basis:
- `pre_wal_delete_script`: _hook script_ executed _before_
the deletion of a WAL file
- `pre_wal_delete_retry_script`: _retry hook script_ executed _before_
the deletion of a WAL file, repeatedly until it is successful
or aborted
- `post_wal_delete_retry_script`: _retry hook script_ executed _after_
the deletion of a WAL file, repeatedly until it is successful
or aborted
- `post_wal_delete_script`: _hook script_ executed _after_
the deletion of a WAL file
The script is executed through a shell and can return any exit code.
Only in case of a _retry_ script, Barman checks the return code (see
the upper section).
WAL delete scripts use the same environmental variables as WAL archive
scripts.
### Recovery scripts
Version **2.4** introduces pre and post recovery scripts.
As previous scripts, recovery scripts can be configured within global
configuration options, and is possible to override them on a per server
basis:
- `pre_recovery_script`: _hook script_ launched _before_ the recovery
of a backup, only once, with no check on the exit code
- `pre_recovery_retry_script`: _retry hook script_ executed _before_
the recovery of a backup, repeatedly until success or abort
- `post_recovery_retry_script`: _retry hook script_ executed _after_
the recovery of a backup, repeatedly until success or abort
- `post_recovery_script`: _hook script_ launched _after_ the recovery
of a backup, only once, with no check on the exit code
The script is executed through a shell and can return any exit code.
Only in case of a _retry_ script, Barman checks the return code (see
the upper section).
Recovery scripts uses the same environmental variables of a backup
script, plus:
- `BARMAN_DESTINATION_DIRECTORY`: the directory where the new instance
is recovered
- `BARMAN_TABLESPACES`: tablespace relocation map (JSON, if present)
- `BARMAN_REMOTE_COMMAND`: secure shell command used
by the recovery (if present)
- `BARMAN_RECOVER_OPTIONS`: recovery additional options (JSON, if present)
## Customization
### Lock file directory
Barman allows you to specify a directory for lock files through the
`barman_lock_directory` global option.
Lock files are used to coordinate concurrent work at global and server
level (for example, cron operations, backup operations, access to the
WAL archive, and so on.).
By default (for backward compatibility reasons),
`barman_lock_directory` is set to `barman_home`.
> **TIP:**
> Users are encouraged to use a directory in a volatile partition,
> such as the one dedicated to run-time variable data (e.g.
> `/var/run/barman`).
### Binary paths
As of version 1.6.0, Barman allows users to specify one or more directories
where Barman looks for executable files, using the global/server
option `path_prefix`.
If a `path_prefix` is provided, it must contain a list of one or more
directories separated by colon. Barman will search inside these directories
first, then in those specified by the `PATH` environment variable.
By default the `path_prefix` option is empty.
## Integration with cluster management systems
Barman has been designed for integration with standby servers (with
streaming replication or traditional file based log shipping) and high
availability tools like [repmgr][repmgr].
From an architectural point of view, PostgreSQL must be configured to
archive WAL files directly to the Barman server.
Barman, thanks to the `get-wal` framework, can also be used as a WAL hub.
For this purpose, you can use the `barman-wal-restore` script, part
of the `barman-cli` package, with all your standby servers.
The `replication-status` command allows
you to get information about any streaming client attached to the
managed server, in particular hot standby servers and WAL streamers.
## Parallel jobs
By default, Barman uses only one worker for file copy during both backup and
recover operations. Starting from version 2.2, it is possible to customize the
number of workers that will perform file copy. In this case, the
files to be copied will be equally distributed among all parallel workers.
It can be configured in global and server scopes, adding these in the
corresponding configuration file:
``` ini
parallel_jobs = n
```
where `n` is the desired number of parallel workers to be used in file copy
operations. The default value is 1.
In any case, users can override this value at run-time when executing
`backup` or `recover` commands. For example, you can use 4 parallel workers
as follows:
``` bash
barman backup --jobs 4 server1
```
Or, alternatively:
``` bash
barman backup --j 4 server1
```
Please note that this parallel jobs feature is only available for servers
configured through `rsync`/SSH. For servers configured through streaming
protocol, Barman will rely on `pg_basebackup` which is currently limited
to only one worker.
## Geographical redundancy
It is possible to set up **cascading backup architectures** with Barman,
where the source of a backup server
is a Barman installation rather than a PostgreSQL server.
This feature allows users to transparently keep _geographically distributed_
copies of PostgreSQL backups.
In Barman jargon, a backup server that is connected to a Barman installation
rather than a PostgreSQL server is defined **passive node**.
A passive node is configured through the `primary_ssh_command` option, available
both at global (for a full replica of a primary Barman installation) and server
level (for mixed scenarios, having both _direct_ and _passive_ servers).
### Sync information
The `barman sync-info` command is used to collect information regarding the
current status of a Barman server that is useful for synchronisation purposes.
The available syntax is the following:
``` bash
barman sync-info [--primary] [ []]
```
The command returns a JSON object containing:
- A map with all the backups having status `DONE` for that server
- A list with all the archived WAL files
- The configuration for the server
- The last read position (in the _xlog database file_)
- the name of the last read WAL file
The JSON response contains all the required information for the synchronisation
between the `master` and a `passive` node.
If `--primary` is specified, the command is executed on the defined
primary node, rather than locally.
### Configuration
Configuring a server as `passive node` is a quick operation.
Simply add to the server configuration the following option:
``` ini
primary_ssh_command = ssh barman@primary_barman
```
This option specifies the SSH connection parameters to the primary server,
identifying the source of the backup data for the passive server.
If you are invoking barman with the `-c/--config` option and you want to use
the same option when the passive node invokes barman on the primary node then
add the following option:
``` ini
forward_config_path = true
```
### Node synchronisation
When a node is marked as `passive` it is treated in a special way by Barman:
- it is excluded from standard maintenance operations
- direct operations to PostgreSQL are forbidden, including `barman backup`
Synchronisation between a passive server and its primary is automatically
managed by `barman cron` which will transparently invoke:
1. `barman sync-info --primary`, in order to collect synchronisation information
2. `barman sync-backup`, in order to create a local copy of every backup that is available on the primary node
3. `barman sync-wals`, in order to copy locally all the WAL files available on the primary node
### Manual synchronisation
Although `barman cron` automatically manages passive/primary node
synchronisation, it is possible to manually trigger synchronisation
of a backup through:
``` bash
barman sync-backup
```
Launching `sync-backup` barman will use the primary_ssh_command to connect to the master server, then
if the backup is present on the remote machine, will begin to copy all the files using rsync.
Only one single synchronisation process per backup is allowed.
WAL files also can be synchronised, through:
``` bash
barman sync-wals
```
barman-2.18/doc/manual/00-head.en.md 0000644 0006212 0006212 00000001422 14172556763 015162 0 ustar 0000000 0000000 % Barman Manual
% EnterpriseDB UK Limited
% January 21, 2022 (2.18)
**Barman** (Backup and Recovery Manager) is an open-source administration tool for disaster recovery of PostgreSQL servers written in Python. It allows your organisation to perform remote backups of multiple servers in business critical environments to reduce risk and help DBAs during the recovery phase.
[Barman][11] is distributed under GNU GPL 3 and maintained by [EnterpriseDB][13], a platinum sponsor of the [PostgreSQL project][31].
> **IMPORTANT:** \newline
> This manual assumes that you are familiar with theoretical disaster
> recovery concepts, and that you have a grasp of PostgreSQL fundamentals in
> terms of physical backup and disaster recovery. See section _"Before you start"_ below for details.
barman-2.18/doc/manual/22-config_file.en.md 0000644 0006212 0006212 00000001536 14172556763 016537 0 ustar 0000000 0000000 ## The server configuration file
Create a new file, called `pg.conf`, in `/etc/barman.d` directory, with the following content:
``` ini
[pg]
description = "Our main PostgreSQL server"
conninfo = host=pg user=barman dbname=postgres
backup_method = postgres
# backup_method = rsync
```
The `conninfo` option is set accordingly to the section _"Preliminary
steps: PostgreSQL connection"_.
The meaning of the `backup_method` option will be covered in the
backup section of this guide.
If you plan to use the streaming connection for WAL archiving or to
create a backup of your server, you also need a `streaming_conninfo`
parameter in your server configuration file:
``` ini
streaming_conninfo = host=pg user=streaming_barman dbname=postgres
```
This value must be chosen accordingly as described in the section
_"Preliminary steps: PostgreSQL connection"_.
barman-2.18/doc/manual/17-configuration.en.md 0000644 0006212 0006212 00000006754 14172556763 017155 0 ustar 0000000 0000000 \newpage
# Configuration
There are two types of configuration files in Barman:
- **global/general configuration**
- **server configuration**
The main configuration file (set to `/etc/barman.conf` by default) contains general options such as main directory, system user, log file, and so on.
Server configuration files, one for each server to be backed up by Barman, are located in the `/etc/barman.d` directory and must have a `.conf` suffix.
> **IMPORTANT**: For historical reasons, you can still have one single
> configuration file containing both global and server options. However,
> for maintenance reasons, this approach is deprecated.
Configuration files in Barman follow the _INI_ format.
Configuration files accept distinct types of parameters:
- string
- enum
- integer
- boolean, `on/true/1` are accepted as well are `off/false/0`.
None of them requires to be quoted.
> *NOTE*: some `enum` allows `off` but not `false`.
## Options scope
Every configuration option has a _scope_:
- global
- server
- global/server: server options that can be generally set at global level
Global options are allowed in the _general section_, which is identified in the INI file by the `[barman]` label:
``` ini
[barman]
; ... global and global/server options go here
```
Server options can only be specified in a _server section_, which is identified by a line in the configuration file, in square brackets (`[` and `]`). The server section represents the ID of that server in Barman. The following example specifies a section for the server named `pg`:
``` ini
[pg]
; Configuration options for the
; server named 'pg' go here
```
There are two reserved words that cannot be used as server names in Barman:
- `barman`: identifier of the global section
- `all`: a handy shortcut that allows you to execute some commands on every server managed by Barman in sequence
Barman implements the **convention over configuration** design paradigm, which attempts to reduce the number of options that you are required to configure without losing flexibility. Therefore, some server options can be defined at global level and overridden at server level, allowing users to specify a generic behavior and refine it for one or more servers. These options have a global/server scope.
For a list of all the available configurations
and their scope, please refer to [section 5 of the 'man' page][man5].
``` bash
man 5 barman
```
## Examples of configuration
The following is a basic example of main configuration file:
``` ini
[barman]
barman_user = barman
configuration_files_directory = /etc/barman.d
barman_home = /var/lib/barman
log_file = /var/log/barman/barman.log
log_level = INFO
compression = gzip
```
The example below, on the other hand, is a server configuration file that uses streaming backup:
``` ini
[streaming-pg]
description = "Example of PostgreSQL Database (Streaming-Only)"
conninfo = host=pg user=barman dbname=postgres
streaming_conninfo = host=pg user=streaming_barman
backup_method = postgres
streaming_archiver = on
slot_name = barman
```
The following code shows a basic example of traditional backup using `rsync`/SSH:
``` ini
[ssh-pg]
description = "Example of PostgreSQL Database (via Ssh)"
ssh_command = ssh postgres@pg
conninfo = host=pg user=barman dbname=postgres
backup_method = rsync
parallel_jobs = 1
reuse_backup = link
archiver = on
```
For more detailed information, please refer to the distributed
`barman.conf` file, as well as the `ssh-server.conf-template` and `streaming-server.conf-template` template files.
barman-2.18/doc/manual/16-installation.en.md 0000644 0006212 0006212 00000013676 14172556763 017007 0 ustar 0000000 0000000 \newpage
# Installation
> **IMPORTANT:**
> The recommended way to install Barman is by using the available
> packages for your GNU/Linux distribution.
## Installation on RedHat/CentOS using RPM packages
Barman can be installed on RHEL7 and RHEL6 Linux systems using
RPM packages. It is required to install the Extra Packages Enterprise
Linux (EPEL) repository and the
[PostgreSQL Global Development Group RPM repository][yumpgdg] beforehand.
Official RPM packages for Barman are distributed by EnterpriseDB
via Yum through the [public RPM repository][2ndqrpmrepo],
by following the instructions you find on that website.
Then, as `root` simply type:
``` bash
yum install barman
```
> **NOTE: **
> We suggest that you exclude any Barman related packages from getting updated
> via the PGDG repository. This can be done by adding the following line
> to any PGDG repository definition that is included in the Barman server inside
> any `/etc/yum.repos.d/pgdg-*.repo` file:
```ini
exclude=barman* python*-barman
```
> By doing this, you solely rely on
> EnterpriseDB repositories for package management of Barman software.
For historical reasons, EnterpriseDB keeps maintaining package distribution of
Barman through [Sourceforge.net][3].
## Installation on Debian/Ubuntu using packages
Barman can be installed on Debian and Ubuntu Linux systems using
packages.
It is directly available in the official repository for Debian and Ubuntu, however, these repositories might not contain the latest available version.
If you want to have the latest version of Barman, the recommended method is to install both these repositories:
* [Public APT repository][2ndqdebrepo], directly maintained by
Barman developers
* the [PostgreSQL Community APT repository][aptpgdg], by following instructions in the [APT section of the PostgreSQL Wiki][aptpgdgwiki]
> **NOTE:**
> Thanks to the direct involvement of Barman developers in the
> PostgreSQL Community APT repository project, you will always have access
> to the most updated versions of Barman.
Installing Barman is as easy. As `root` user simply type:
``` bash
apt-get install barman
```
## Installation from sources
> **WARNING:**
> Manual installation of Barman from sources should only be performed
> by expert GNU/Linux users. Installing Barman this way requires
> system administration activities such as dependencies management,
> `barman` user creation, configuration of the `barman.conf` file,
> cron setup for the `barman cron` command, log management, and so on.
Create a system user called `barman` on the `backup` server.
As `barman` user, download the sources and uncompress them.
For a system-wide installation, type:
``` bash
barman@backup$ ./setup.py build
# run this command with root privileges or through sudo
barman@backup# ./setup.py install
```
For a local installation, type:
``` bash
barman@backup$ ./setup.py install --user
```
The `barman` application will be installed in your user directory ([make sure that your `PATH` environment variable is set properly][setup_user]).
[Barman is also available on the Python Package Index (PyPI)][pypi] and can be installed through `pip`.
## PostgreSQL client binaries
The following Barman features depend on PostgreSQL client binaries:
* [Streaming backup](#streaming-backup) with `backup_method = postgres` (requires `pg_basebackup`)
* [Streaming WAL archiving](#wal-streaming) with `streaming_archiver = on` (requires
`pg_receivewal` or `pg_receivexlog`)
* [Verifying backups](#verify) with `barman verfy-backup` (requires `pg_verifybackup`)
These binaries are installed with the PostgreSQL client packages and can be
found in the following locations:
* On RedHat/CentOS: `/usr/pgsql-${PG_MAJOR_VERSION}/bin`
* On Debian/Ubuntu: `/usr/lib/postgresql/${PG_MAJOR_VERSION}/bin`
You must ensure that either:
1. The Barman user has the `bin` directory for the appropriate `PG_MAJOR_VERSION`
on its path, or:
2. The [path_prefix](#binary-paths) option is set in the Barman configuration for each
server and points to the `bin` directory for the appropriate
`PG_MAJOR_VERSION`.
# Upgrading Barman
Barman follows the trunk-based development paradigm, and as such
there is only one stable version, the latest. After every commit,
Barman goes through thousands of automated tests for each
supported PostgreSQL version and on each supported Linux distribution.
Also, **every version is back compatible** with previous ones.
Thefore, upgrading Barman normally requires a simple update of packages
using `yum update` or `apt update`.
There have been, however, the following exceptions in our development
history, which required some small changes to the configuration.
## Upgrading from Barman 2.10
If you are using `barman-cloud-wal-archive` or `barman-cloud-backup`
you need to be aware that from version 2.11 all cloud utilities
have been moved into the new `barman-cli-cloud` package.
Therefore, you need to ensure that the `barman-cli-cloud` package
is properly installed as part of the upgrade to the latest version.
If you are not using the above tools, you can upgrade to the latest
version as usual.
## Upgrading from Barman 2.X (prior to 2.8)
Before upgrading from a version of Barman 2.7 or older
users of `rsync` backup method on a primary server should explicitly
set `backup_options` to either `concurrent_backup` (recommended for
PostgreSQL 9.6 or higher) or `exclusive_backup` (current default),
otherwise Barman emits a warning every time it runs.
## Upgrading from Barman 1.X
If your Barman installation is 1.X, you need to explicitly configure
the archiving strategy. Before, the file based archiver, controlled by
`archiver`, was enabled by default.
Before you upgrade your Barman installation to the latest version,
make sure you add the following line either globally or for any server
that requires it:
``` ini
archiver = on
```
Additionally, for a few releases, Barman will transparently set
`archiver = on` with any server that has not explicitly set
an archiving strategy and emit a warning.
barman-2.18/doc/manual/55-barman-cli.en.md 0000644 0006212 0006212 00000013207 14172556763 016304 0 ustar 0000000 0000000 \newpage
# Barman client utilities (`barman-cli`)
Formerly a separate open-source project, `barman-cli` has been
merged into Barman's core since version 2.8, and is distributed
as an RPM/Debian package. `barman-cli` contains a set of recommended
client utilities to be installed alongside the PostgreSQL server:
- `barman-wal-archive`: archiving script to be used as `archive_command`
as described in the "WAL archiving via `barman-wal-archive`" section;
- `barman-wal-restore`: WAL restore script to be used as part of the
`restore_command` recovery option on standby and recovery servers,
as described in the "`get-wal`" section above;
For more detailed information, please refer to the specific man pages
or the `--help` option.
## Installation
Barman client utilities are normally installed where PostgreSQL is installed.
Our recommendation is to install the `barman-cli` package on every PostgreSQL
server, being that primary or standby.
Please refer to the main "Installation" section to install the repositories.
To install the package on RedHat/CentOS system, as `root` type:
``` bash
yum install barman-cli
```
On Debian/Ubuntu, as `root` user type:
``` bash
apt-get install barman-cli
```
# Barman client utilities for the Cloud (`barman-cli-cloud`)
Barman client utilities have been extended to support object storage
integration and enhance disaster recovery capabilities of your PostgreSQL
databases by relaying WAL files and backups to a supported cloud provider.
Supported cloud providers are:
* AWS S3 (or any S3 compatible object store)
* Azure Blob Storage
These utilities are distributed in the `barman-cli-cloud` RPM/Debian package,
and can be installed alongside the PostgreSQL server:
- `barman-cloud-wal-archive`: archiving script to be used as `archive_command`
to directly ship WAL files to cloud storage, bypassing the Barman server;
alternatively, as a hook script for WAL archiving (`pre_archive_retry_script`);
- `barman-cloud-wal-restore`: script to be used as `restore_command`
to fetch WAL files from cloud storage, bypassing the Barman server, and
store them directly in the PostgreSQL standby;
- `barman-cloud-backup`: backup script to be used to take a local backup
directly on the PostgreSQL server and to ship it to a supported cloud provider,
bypassing the Barman server; alternatively, as a hook script for copying barman
backups to the cloud (`post_backup_retry_script)`
- `barman-cloud-backup-delete`: script to be used to delete one or more backups
taken with `barman-cloud-backup` from cloud storage and remove associated
WALs;
- `barman-cloud-backup-keep`: script to be used to flag backups in cloud storage
as archival backups - such backups will be kept forever regardless of any
retention policies applied;
- `barman-cloud-backup-list`: script to be used to list the content of
Barman backups taken with `barman-cloud-backup` from cloud storage;
- `barman-cloud-restore`: script to be used to restore a backup directly
taken with `barman-cloud-backup` from cloud storage;
For information on how to setup credentials for the aws-s3 cloud provider
please refer to the ["Credentials" section in Boto 3 documentation][boto3creds].
For credentials for the azure-blob-storage cloud provider see the
["Environment variables for authorization parameters" section in the Azure documentation][azure-storage-auth].
The following environment variables are supported: `AZURE_STORAGE_CONNECTION_STRING`,
`AZURE_STORAGE_KEY` and `AZURE_STORAGE_SAS_TOKEN`. You can also use the
`--credential` option to specify either `azure-cli` or `managed-identity` credentials
in order to authenticate via Azure Active Directory.
> **WARNING:** Cloud utilities require the appropriate library for the cloud
> provider you wish to use - either: [boto3][boto3] or
> [azure-storage-blob][azure-storage-blob] and (optionally)
> [azure-identity][azure-identity]
## Installation
Barman client utilities for the Cloud need to be installed on those PostgreSQL
servers that you want to direcly backup to a cloud provider, bypassing Barman.
In case you want to use `barman-cloud-backup` and/or `barman-cloud-wal-archive`
as hook scripts, you can install the `barman-cli-cloud` package on the Barman
server also.
Please refer to the main "Installation" section to install the repositories.
To install the package on RedHat/CentOS system, as `root` type:
``` bash
yum install barman-cli-cloud
```
On Debian/Ubuntu, as `root` user type:
``` bash
apt-get install barman-cli-cloud
```
## barman-cloud hook scripts
Install the `barman-cli-cloud` package on the Barman server as described above.
Configure `barman-cloud-backup` as a post backup script by adding the following
to the Barman configuration for a PostgreSQL server:
```
post_backup_retry_script = 'barman-cloud-backup [*OPTIONS*] *DESTINATION_URL* ${BARMAN_SERVER}
```
> **WARNING:** When running as a hook script barman-cloud-backup requires that
> the status of the backup is DONE and it will fail if the backup has any other
> status. For this reason it is recommended backups are run with the
> `-w / --wait` option so that the hook script is not executed while a
> backup has status `WAITING_FOR_WALS`.
Configure `barman-cloud-wal-archive` as a pre WAL archive script by adding the
following to the Barman configuration for a PostgreSQL server:
```
pre_archive_retry_script = 'barman-cloud-wal-archive [*OPTIONS*] *DESTINATION_URL* ${BARMAN_SERVER}'
```
## Selecting a cloud provider
Use the `--cloud-provider` option to choose the cloud provider for your backups
and WALs. This can be set to one of the following:
* `aws-s3` [DEFAULT]: AWS S3 or S3-compatible object store.
* `azure-blob-storage`: Azure Blob Storage service.
barman-2.18/doc/manual/20-server_setup.en.md 0000644 0006212 0006212 00000001467 14172556763 017022 0 ustar 0000000 0000000 \newpage
# Setup of a new server in Barman
As mentioned in the _"Design and architecture"_ section, we will use the
following conventions:
- `pg` as server ID and host name where PostgreSQL is installed
- `backup` as host name where Barman is located
- `barman` as the user running Barman on the `backup` server (identified by
the parameter `barman_user` in the configuration)
- `postgres` as the user running PostgreSQL on the `pg` server
> **IMPORTANT:** a server in Barman must refer to the same PostgreSQL
> instance for the whole backup and recoverability history (i.e. the
> same system identifier). **This means that if you perform an upgrade
> of the instance (using for example `pg_upgrade`, you must not reuse
> the same server definition in Barman, rather use another one as they
> have nothing in common.**
barman-2.18/doc/manual/24-wal_archiving.en.md 0000644 0006212 0006212 00000011502 14172556763 017104 0 ustar 0000000 0000000 ## WAL archiving via `archive_command`
The `archive_command` is the traditional method to archive WAL files.
The value of this PostgreSQL configuration parameter must be a shell
command to be executed by the PostgreSQL server to copy the WAL files
to the Barman incoming directory.
This can be done in two ways, both requiring a SSH connection:
- via `barman-wal-archive` utility (from Barman 2.6)
- via rsync/SSH (common approach before Barman 2.6)
See sections below for more details.
> **IMPORTANT:** PostgreSQL 9.5 introduced support for WAL file
> archiving using `archive_command` from a standby. Read the
> "Concurrent Backup and backup from a standby" section for more
> detailed information on how Barman supports this feature.
### WAL archiving via `barman-wal-archive`
From Barman 2.6, the **recommended way** to safely and reliably archive WAL
files to Barman via `archive_command` is to use the `barman-wal-archive`
command contained in the `barman-cli` package,
distributed via EnterpriseDB public repositories and available under
GNU GPL 3 licence. `barman-cli` must be installed on each PostgreSQL
server that is part of the Barman cluster.
Using `barman-wal-archive` instead of rsync/SSH reduces the risk
of data corruption of the shipped WAL file on the Barman server.
When using rsync/SSH as `archive_command` a WAL file, there is no
mechanism that guarantees that the content of the file is flushed
and fsync-ed to disk on destination.
For this reason, we have developed the `barman-wal-archive` utility
that natively communicates with Barman's `put-wal` command (introduced in 2.6),
which is responsible to receive the file, fsync its content and place
it in the proper `incoming` directory for that server. Therefore,
`barman-wal-archive` reduces the risk of copying a WAL file in the
wrong location/directory in Barman, as the only parameter to be used
in the `archive_command` is the server's ID.
For more information on the `barman-wal-archive` command, type `man barman-wal-archive`
on the PostgreSQL server.
You can check that `barman-wal-archive` can connect to the Barman server,
and that the required PostgreSQL server is configured in Barman to accept
incoming WAL files with the following command:
``` bash
barman-wal-archive --test backup pg DUMMY
```
Where `backup` is the host where Barman is installed, `pg` is the name
of the PostgreSQL server as configured in Barman and DUMMY is a placeholder
(`barman-wal-archive` requires an argument for the WAL file name,
which is ignored).
Edit the `postgresql.conf` file of the PostgreSQL instance on the `pg`
database, activate the archive mode and set `archive_command` to use
`barman-wal-archive`:
``` ini
archive_mode = on
wal_level = 'replica'
archive_command = 'barman-wal-archive backup pg %p'
```
Then restart the PostgreSQL server.
### WAL archiving via rsync/SSH
You can retrieve the incoming WALs directory using the `show-servers`
Barman command and looking for the `incoming_wals_directory` value:
``` bash
barman@backup$ barman show-servers pg |grep incoming_wals_directory
incoming_wals_directory: /var/lib/barman/pg/incoming
```
Edit the `postgresql.conf` file of the PostgreSQL instance on the `pg`
database and activate the archive mode:
``` ini
archive_mode = on
wal_level = 'replica'
archive_command = 'rsync -a %p barman@backup:INCOMING_WALS_DIRECTORY/%f'
```
Make sure you change the `INCOMING_WALS_DIRECTORY` placeholder with
the value returned by the `barman show-servers pg` command above.
Restart the PostgreSQL server.
In some cases, you might want to add stricter checks to the `archive_command`
process. For example, some users have suggested the following one:
``` ini
archive_command = 'test $(/bin/hostname --fqdn) = HOSTNAME \
&& rsync -a %p barman@backup:INCOMING_WALS_DIRECTORY/%f'
```
Where the `HOSTNAME` placeholder should be replaced with the value
returned by `hostname --fqdn`. This _trick_ is a safeguard in case
the server is cloned and avoids receiving WAL files from recovered
PostgreSQL instances.
## Verification of WAL archiving configuration
In order to test that continuous archiving is on and properly working,
you need to check both the PostgreSQL server and the backup server. In
particular, you need to check that WAL files are correctly collected
in the destination directory.
For this purpose and to facilitate the verification of the WAL archiving process,
the `switch-wal` command has been developed:
``` bash
barman@backup$ barman switch-wal --force --archive pg
```
The above command will force PostgreSQL to switch WAL file and
trigger the archiving process in Barman. Barman will wait for one
file to arrive within 30 seconds (you can change the timeout through
the `--archive-timeout` option). If no WAL file is received, an error
is returned.
You can verify if the WAL archiving has been correctly configured using
the `barman check` command.
barman-2.18/doc/manual/27-windows-support.en.md 0000644 0006212 0006212 00000002467 14172556763 017510 0 ustar 0000000 0000000 ## How to setup a Windows based server
You can backup a PostgreSQL server running on Windows using the
streaming connection for both WAL archiving and for backups.
> **IMPORTANT:** This feature is still experimental because it is not
> yet part of our continuous integration system.
Follow every step discussed previously for a streaming connection
setup.
> **WARNING:**: At this moment, `pg_basebackup` interoperability from
> Windows to Linux is still experimental. If you are having issues
> taking a backup from a Windows server and your PostgreSQL locale is
> not in English, a possible workaround for the issue is instructing
> your PostgreSQL to emit messages in English. You can do this by
> putting the following parameter in your `postgresql.conf` file:
>
> ``` ini
> lc_messages = 'English'
> ```
>
> This has been reported to fix the issue.
You can backup your server as usual.
Remote recovery is not supported for Windows servers, so you must
recover your cluster locally in the Barman server and then copy all
the files on a Windows server or use a folder shared between the
PostgreSQL server and the Barman server.
Additionally, make sure that the system user chosen to run PostgreSQL
has the permission needed to access the restored data. Basically, it
must have full control over the PostgreSQL data directory.
barman-2.18/doc/manual/42-server-commands.en.md 0000644 0006212 0006212 00000023440 14172556763 017400 0 ustar 0000000 0000000 \newpage
# Server commands
As we said in the previous section, server commands work directly on
a PostgreSQL server or on its area in Barman, and are useful to check
its status, perform maintenance operations, take backups, and
manage the WAL archive.
## `archive-wal`
The `archive-wal` command execute maintenance operations on WAL files
for a given server. This operations include processing of the WAL
files received from the streaming connection or from the
`archive_command` or both.
> **IMPORTANT:**
> The `archive-wal` command, even if it can be directly invoked, is
> designed to be started from the `cron` general command.
## `backup`
The `backup` command takes a full backup (_base backup_) of a given
server. It has several options that let you override the corresponding
configuration parameter for the new backup. For more information,
consult the manual page.
You can perform a full backup for a given server with:
``` bash
barman backup
```
> **TIP:**
> You can use `barman backup all` to sequentially backup all your
> configured servers.
## `check`
You can check the connection to a given server and the
configuration coherence with the `check` command:
``` bash
barman check
```
> **TIP:**
> You can use `barman check all` to check all your configured servers.
> **IMPORTANT:**
> The `check` command is probably the most critical feature that
> Barman implements. We recommend to integrate it with your alerting
> and monitoring infrastructure. The `--nagios` option allows you
> to easily create a plugin for Nagios/Icinga.
## `generate-manifest`
This command is useful when backup is created remotely and pg_basebackup is not
involved and `backup_manifest` file does not exist in backup.
It will generate `backup_manifest` file from backup_id using backup in barman server.
If the file already exist, generation command will abort.
Command example:
```bash
barman generate-manifest
```
Either backup_id [backup id shortcuts]{#backup-id-shortcuts} can be used.
This command can also be used as post_backup hook script as follows:
```bash
post_backup_script=barman generate-manifest ${BARMAN_SERVER} ${BARMAN_BACKUP_ID}
```
## `get-wal`
Barman allows users to request any _xlog_ file from its WAL archive
through the `get-wal` command:
``` bash
barman get-wal [-o OUTPUT_DIRECTORY][-j|-x]
```
If the requested WAL file is found in the server archive, the
uncompressed content will be returned to `STDOUT`, unless otherwise
specified.
The following options are available for the `get-wal` command:
- `-o` allows users to specify a destination directory where Barman
will deposit the requested WAL file
- `-j` will compress the output using `bzip2` algorithm
- `-x` will compress the output using `gzip` algorithm
- `-p SIZE` peeks from the archive up to WAL files, starting from
the requested file
It is possible to use `get-wal` during a recovery operation,
transforming the Barman server into a _WAL hub_ for your servers. This
can be automatically achieved by adding the `get-wal` value to the
`recovery_options` global/server configuration option:
``` ini
recovery_options = 'get-wal'
```
`recovery_options` is a global/server option that accepts a list of
comma separated values. If the keyword `get-wal` is present during a
recovery operation, Barman will prepare the recovery configuration by
setting the `restore_command` so that `barman get-wal` is used to
fetch the required WAL files.
Similarly, one can use the `--get-wal` option for the `recover` command
at run-time.
This is an example of a `restore_command` for a local recovery:
``` ini
restore_command = 'sudo -u barman barman get-wal SERVER %f > %p'
```
Please note that the `get-wal` command should always be invoked as
`barman` user, and that it requires the correct permission to
read the WAL files from the catalog. This is the reason why we are
using `sudo -u barman` in the example.
Setting `recovery_options` to `get-wal` for a remote recovery will instead
generate a `restore_command` using the `barman-wal-restore` script.
`barman-wal-restore` is a more resilient shell script which manages SSH
connection errors.
This script has many useful options such as the automatic compression and
decompression of the WAL files and the *peek* feature, which allows you
to retrieve the next WAL files while PostgreSQL is applying one of them. It is
an excellent way to optimise the bandwidth usage between PostgreSQL and
Barman.
`barman-wal-restore` is available in the `barman-cli` package.
This is an example of a `restore_command` for a remote recovery:
``` ini
restore_command = 'barman-wal-restore -U barman backup SERVER %f %p'
```
Since it uses SSH to communicate with the Barman server, SSH key authentication
is required for the `postgres` user to login as `barman` on the backup server.
You can check that `barman-wal-restore` can connect to the Barman server,
and that the required PostgreSQL server is configured in Barman to send
WAL files with the following command:
``` bash
barman-wal-restore --test backup pg DUMMY DUMMY
```
Where `backup` is the host where Barman is installed, `pg` is the name
of the PostgreSQL server as configured in Barman and DUMMY is a placeholder
(`barman-wal-restore` requires two argument for the WAL file name
and destination directory, which are ignored).
For more information on the `barman-wal-restore` command,
type `man barman-wal-restore` on the PostgreSQL server.
## `list-backups`
You can list the catalog of available backups for a given server
with:
``` bash
barman list-backups
```
> **TIP:** You can request a full list of the backups of all servers
> using `all` as the server name.
To have a machine-readable output you can use the `--minimal` option.
## `rebuild-xlogdb`
At any time, you can regenerate the content of the WAL archive for a
specific server (or every server, using the `all` shortcut). The WAL
archive is contained in the `xlog.db` file and every server managed by
Barman has its own copy.
The `xlog.db` file can be rebuilt with the `rebuild-xlogdb`
command. This will scan all the archived WAL files and regenerate the
metadata for the archive.
For example:
``` bash
barman rebuild-xlogdb
```
## `receive-wal`
This command manages the `receive-wal` process, which uses the
streaming protocol to receive WAL files from the PostgreSQL streaming
connection.
### receive-wal process management
If the command is run without options, a `receive-wal` process will
be started. This command is based on the `pg_receivewal` PostgreSQL
command.
``` bash
barman receive-wal
```
> **NOTE:**
> The `receive-wal` command is a foreground process.
If the command is run with the `--stop` option, the currently running
`receive-wal` process will be stopped.
The `receive-wal` process uses a status file to track last written
record of the transaction log. When the status file needs to be
cleaned, the `--reset` option can be used.
> **IMPORTANT:** If you are not using replication slots, you rely
> on the value of `wal_keep_segments` (or `wal_keep_size` from
> PostgreSQL version 13.0 onwards). Be aware that under high peaks
> of workload on the database, the `receive-wal` process
> might fall behind and go out of sync. As a precautionary measure,
> Barman currently requires that users manually execute the command with the
> `--reset` option, to avoid making wrong assumptions.
### Replication slot management
The `receive-wal` process is also useful to create or drop the
replication slot needed by Barman for its WAL archiving procedure.
With the `--create-slot` option, the replication slot named after the
`slot_name` configuration option will be created on the PostgreSQL
server.
With the `--drop-slot`, the previous replication slot will be deleted.
## `replication-status`
The `replication-status` command reports the status of any streaming
client currently attached to the PostgreSQL server, including the
`receive-wal` process of your Barman server (if configured).
You can execute the command as follows:
``` bash
barman replication-status
```
> **TIP:** You can request a full status report of the replica
> for all your servers using `all` as the server name.
To have a machine-readable output you can use the `--minimal` option.
## `show-servers`
You can show the configuration parameters for a given server with:
``` bash
barman show-servers
```
> **TIP:** you can request a full configuration report using `all` as
> the server name.
## `status`
The `status` command shows live information and status of a PostgreSQL
server or of all servers if you use `all` as server name.
``` bash
barman status
```
## `switch-wal`
This command makes the PostgreSQL server switch to another transaction
log file (WAL), allowing the current log file to be closed, received and then
archived.
``` bash
barman switch-wal
```
If there has been no transaction activity since the last transaction
log file switch, the switch needs to be forced using the
`--force` option.
The `--archive` option requests Barman to trigger WAL archiving after
the xlog switch. By default, a 30 seconds timeout is enforced (this
can be changed with `--archive-timeout`). If no WAL file is received,
an error is returned.
> **NOTE:** In Barman 2.1 and 2.2 this command was called `switch-xlog`.
> It has been renamed for naming consistency with PostgreSQL 10 and higher.
## `verify`
The `verify` command uses backup_manifest file from backup and runs
`pg_verifybackup` against it.
```bash
barman verify
```
This command will call `pg_verifybackup -n` (available on PG>=13)
`pg_verifybackup` Must be installed on backup server.
For rsync backups, it can be used with `generate-manifest` command.
Either backup_id [backup id shortcuts]{#backup-id-shortcuts} can be used.
barman-2.18/doc/manual/15-system_requirements.en.md 0000644 0006212 0006212 00000004510 14172556763 020417 0 ustar 0000000 0000000 \newpage
# System requirements
- Linux/Unix
- Python >= 3.4
- Python modules:
- argcomplete
- psycopg2 >= 2.4.2
- python-dateutil
- setuptools
- PostgreSQL >= 8.3
- rsync >= 3.0.4 (optional for PostgreSQL >= 9.2)
> **IMPORTANT:**
> Users of RedHat Enterprise Linux, CentOS and Scientific Linux are
> required to install the
> [Extra Packages Enterprise Linux (EPEL) repository][epel].
> **NOTE:**
> Support for Python 2.6 and 2.7 is deprecated and will be discontinued in future releases.
> Support for PostgreSQL < 9.4 is deprecated and will be discontinued in future releases.
## Requirements for backup
The most critical requirement for a Barman server is the amount of disk space available.
You are recommended to plan the required disk space based on the size of the cluster, number of WAL files generated per day, frequency of backups, and retention policies.
Although the only file systems that we officially support are XFS and Ext4, we are aware of users that deploy Barman on different file systems including ZFS and NFS.
## Requirements for recovery
Barman allows you to recover a PostgreSQL instance either
locally (where Barman resides) or remotely (on a separate server).
Remote recovery is definitely the most common way to restore a PostgreSQL
server with Barman.
Either way, the same [requirements for PostgreSQL's Log shipping and Point-In-Time-Recovery apply][requirements_recovery]:
- identical hardware architecture
- identical major version of PostgreSQL
In general, it is **highly recommended** to create recovery environments that are as similar as possible, if not identical, to the original server, because they are easier to maintain. For example, we suggest that you use the same operating system, the same PostgreSQL version, the same disk layouts, and so on.
Additionally, dedicated recovery environments for each PostgreSQL server, even on demand, allows you to nurture the disaster recovery culture in your team. You can be prepared for when something unexpected happens by practising
recovery operations and becoming familiar with them.
Based on our experience, designated recovery environments reduce the impact of stress in real failure situations, and therefore increase the effectiveness of recovery operations.
Finally, it is important that time is synchronised between the servers, using NTP for example.
barman-2.18/doc/manual/43-backup-commands.en.md 0000644 0006212 0006212 00000027151 14172556763 017343 0 ustar 0000000 0000000 \newpage
# Backup commands
Backup commands are those that works directly on backups already existing in
Barman's backup catalog.
> **NOTE:**
> Remember a backup ID can be retrieved with `barman list-backups
> `
## Backup ID shortcuts
Barman allows you to use special keywords to identify a specific backup:
* `last/latest`: identifies the newest backup in the catalog
* `first/oldest`: identifies the oldest backup in the catalog
* `last-failed`: identifies the newest failed backup in the catalog
Using those keywords with Barman commands allows you to execute actions
without knowing the exact ID of a backup for a server.
For example we can issue:
``` bash
barman delete oldest
```
to remove the oldest backup available in the catalog and reclaim disk space.
## `check-backup`
Starting with version 2.5, you can check that all required WAL files
for the consistency of a full backup have been correctly archived by
`barman` with the `check-backup` command:
``` bash
barman check-backup
```
> **IMPORTANT:**
> This command is automatically invoked by `cron` and at the end of a
> `backup` operation. This means that, under normal circumstances,
> you should never need to execute it.
In case one or more WAL files from the start to the end of the backup
have not been archived yet, `barman` will label the backup as
`WAITING_FOR_WALS`. The `cron` command will continue to check that
missing WAL files are archived, then label the backup as `DONE`.
In case the first required WAL file is missing at the end of the
backup, such backup will be marked as `FAILED`. It is therefore
important that you verify that WAL archiving (whether via streaming
or `archive_command`) is properly working before executing a backup
operation - especially when backing up from a standby server.
Barman 2.10 introduces the `-w`/`--wait` option for the `backup` command.
When set, Barman temporarily saves the state of the backup to
`WAITING_FOR_WALS`, then waits for all the required WAL files to be
archived before setting the state to `DONE` and proceeding
with post-backup hook scripts.
## `delete`
You can delete a given backup with:
``` bash
barman delete
```
The `delete` command accepts any [shortcut](#backup-id-shortcuts) to identify backups.
## `keep`
If you have a backup which you wish to keep beyond the retention policy of
the server then you can make it an archival backup with:
```bash
barman keep [--target TARGET, --status, --release]
```
Possible values for `TARGET` are:
- `full`: The backup can always be used to recover to the latest point in
time. To achieve this, Barman will retain all WALs needed to ensure
consistency of the backup and all subsequent WALs.
- `standalone`: The backup can only be used to recover the server to its
state at the time the backup was taken. Barman will only retain the WALs
needed to ensure consistency of the backup.
If the `--status` option is provided then Barman will report the archival
status of the backup. This will either be the recovery target of `full` or
`standalone` for archival backups or `nokeep` for backups which have not
been flagged as archival.
If the `--release` option is provided then Barman will release the keep
flag from this backup. This will remove its archival status and make it
available for deletion, either directly or by retention policy.
Once a backup has been flagged as an archival backup, the behaviour of
Barman will change as follows:
- Attempts to delete that backup by ID using `barman delete` will fail.
- Retention policies will never consider that backup as `OBSOLETE` and
therefore `barman cron` will never delete that backup.
- The WALs required by that backup will be retained forever. If the
specified recovery target is `full` then *all* subsequent WALs will also
be retained.
This can be reverted by removing the keep flag with
`barman keep --release`.
> **WARNING:** Once a `standalone` archival backup is not required by the
> retention policy of a server `barman cron` will remove the WALs between
> that backup and the begin_wal value of the next most recent backup. This
> means that while it is safe to change the target from `full` to `standalone`,
> it is *not* safe to change the target from `standalone` to `full` because
> there is no guarantee the necessary WALs for a recovery to the latest point
> in time will still be available.
## `list-files`
You can list the files (base backup and required WAL files) for a
given backup with:
``` bash
barman list-files [--target TARGET_TYPE]
```
With the `--target TARGET_TYPE` option, it is possible to choose the
content of the list for a given backup.
Possible values for `TARGET_TYPE` are:
- `data`: lists the data files
- `standalone`: lists the base backup files, including required WAL
files
- `wal`: lists all WAL files from the beginning of the base backup to
the start of the following one (or until the end of the log)
- `full`: same as `data` + `wal`
The default value for `TARGET_TYPE` is `standalone`.
> **IMPORTANT:**
> The `list-files` command facilitates interaction with external
> tools, and can therefore be extremely useful to integrate
> Barman into your archiving procedures.
## `recover`
The `recover` command is used to recover a whole server after
a backup is executed using the `backup` command.
This is achieved issuing a command like the following:
```bash
barman@backup$ barman recover /path/to/recover/dir
```
> **IMPORTANT:**
> Do not issue a `recover` command using a target data directory where
> a PostgreSQL instance is running. In that case, remember to stop it
> before issuing the recovery. This applies also to tablespace directories.
At the end of the execution of the recovery, the selected backup is recovered
locally and the destination path contains a data directory ready to be used
to start a PostgreSQL instance.
> **IMPORTANT:**
> Running this command as user `barman`, it will become the database superuser.
The specific ID of a backup can be retrieved using the [list-backups](#list-backups)
command.
> **IMPORTANT:**
> Barman does not currently keep track of symbolic links inside PGDATA
> (except for tablespaces inside pg_tblspc). We encourage
> system administrators to keep track of symbolic links and to add them
> to the disaster recovery plans/procedures in case they need to be restored
> in their original location.
The recovery command has several options that modify the command behavior.
### Remote recovery
Add the `--remote-ssh-command ` option to the invocation
of the recovery command. Doing this will allow Barman to execute
the copy on a remote server, using the provided command to connect
to the remote host.
> **NOTE:**
> It is advisable to use the `postgres` user to perform
> the recovery on the remote host.
> **IMPORTANT:**
> Do not issue a `recover` command using a target data directory where
> a PostgreSQL instance is running. In that case, remember to stop it
> before issuing the recovery. This applies also to tablespace directories.
Known limitations of the remote recovery are:
* Barman requires at least 4GB of free space in the system temporary directory
unless the [`get-wal`](#get-wal) command is specified
in the `recovery_option` parameter in the Barman configuration.
* The SSH connection between Barman and the remote host **must** use the
public key exchange authentication method
* The remote user **must** be able to create the directory structure
of the backup in the destination directory.
* There must be enough free space on the remote server
to contain the base backup and the WAL files needed for recovery.
### Tablespace remapping
Barman is able to automatically remap one or more tablespaces using
the recover command with the --tablespace option.
The option accepts a pair of values as arguments using the
`NAME:DIRECTORY` format:
* `NAME` is the identifier of the tablespace
* `DIRECTORY` is the new destination path for the tablespace
If the destination directory does not exists,
Barman will try to create it (assuming you have the required permissions).
### Point in time recovery
Barman wraps PostgreSQL's Point-in-Time Recovery (PITR),
allowing you to specify a recovery target, either as a timestamp,
as a restore label, or as a transaction ID.
> **IMPORTANT:**
> The earliest PITR for a given backup is the end of the base
> backup itself. If you want to recover at any point in time
> between the start and the end of a backup, you must use
> the previous backup. From Barman 2.3 you can exit recovery
> when consistency is reached by using `--target-immediate` option
> (available only for PostgreSQL 9.4 and newer).
The recovery target can be specified using one of
the following mutually exclusive options:
* `--target-time TARGET_TIME`: to specify a timestamp
* `--target-xid TARGET_XID`: to specify a transaction ID
* `--target-lsn TARGET_LSN`: to specify a Log Sequence Number (LSN) -
requires PostgreSQL 10 or higher
* `--target-name TARGET_NAME`: to specify a named restore point
previously created with the pg_create_restore_point(name)
function[^TARGET_NAME]
* `--target-immediate`: recovery ends when a consistent state is reached
(that is the end of the base backup process)
[^RECOVERY_TARGET_IMMEDIATE]
> **IMPORTANT:**
> Recovery target via _time_, _XID_ and LSN **must be** subsequent to the
> end of the backup. If you want to recover to a point in time between
> the start and the end of a backup, you must recover from the
> previous backup in the catalogue.
[^TARGET_NAME]:
Only available on PostgreSQL 9.1 and above
[^RECOVERY_TARGET_IMMEDIATE]:
Only available on PostgreSQL 9.4 and above
You can use the `--exclusive` option to specify whether to stop immediately
before or immediately after the recovery target.
Barman allows you to specify a target timeline for recovery,
using the `target-tli` option. The notion of timeline goes beyond the scope of
this document; you can find more details in the PostgreSQL documentation,
as mentioned in the _"Before you start"_ section.
Barman 2.4 introduces support for `--target-action` option, accepting
the following values:
* `shutdown`: once recovery target is reached, PostgreSQL is shut down [^TARGET_SHUTDOWN]
* `pause`: once recovery target is reached, PostgreSQL is started in pause
state, allowing users to inspect the instance [^TARGET_PAUSE]
* `promote`: once recovery target is reached, PostgreSQL will exit recovery
and is promoted as a master [^TARGET_PROMOTE]
> **IMPORTANT:**
> By default, no target action is defined (for back compatibility).
> The `--target-action` option requires a Point In Time Recovery target
> to be specified.
[^TARGET_SHUTDOWN]:
Only available on PostgreSQL 9.5 and above
[^TARGET_PAUSE]:
Only available on PostgreSQL 9.1 and above
[^TARGET_PROMOTE]:
Only available on PostgreSQL 9.5 and above
For more detailed information on the above settings, please consult
the [PostgreSQL documentation on recovery target settings][target].
Barman 2.4 also adds the `--standby-mode` option for the `recover`
command which, if specified, properly configures the recovered instance
as a standby by creating a `standby.signal` file (from PostgreSQL 12)
or by adding `standby_mode = on` to the generated recovery configuration.
Further information on _standby mode_ is available in the PostgreSQL documentation.
## `show-backup`
You can retrieve all the available information for a particular backup of
a given server with:
``` bash
barman show-backup
```
The `show-backup` command accepts any [shortcut](#backup-id-shortcuts) to identify backups.
barman-2.18/doc/manual/66-about.en.md 0000644 0006212 0006212 00000007065 14172556763 015420 0 ustar 0000000 0000000 \newpage
# The Barman project
## Support and sponsor opportunities
Barman is free software, written and maintained by EnterpriseDB. If you
require support on using Barman, or if you need new features, please
get in touch with EnterpriseDB. You can sponsor the development of new
features of Barman and PostgreSQL which will be made publicly
available as open source.
For further information, please visit:
- [Barman website][11]
- [Support section][12]
- [EnterpriseDB website][13]
- [Barman FAQs][14]
- [2ndQuadrant blog: Barman][15]
## Contributing to Barman
EnterpriseDB has a team of software engineers, architects, database
administrators, system administrators, QA engineers, developers and
managers that dedicate their time and expertise to improve Barman's code.
We adopt lean and agile methodologies for software development, and
we believe in the _devops_ culture that allowed us to implement rigorous
testing procedures through cross-functional collaboration.
Every Barman commit is the contribution of multiple individuals, at different
stages of the production pipeline.
Even though this is our preferred way of developing Barman, we gladly
accept patches from external developers, as long as:
- user documentation (tutorial and man pages) is provided.
- source code is properly documented and contains relevant comments.
- code supplied is covered by unit tests.
- no unrelated feature is compromised or broken.
- source code is rebased on the current master branch.
- commits and pull requests are limited to a single feature (multi-feature
patches are hard to test and review).
- changes to the user interface are discussed beforehand with EnterpriseDB.
We also require that any contributions provide a copyright assignment
and a disclaimer of any work-for-hire ownership claims from the employer
of the developer.
You can use Github's pull requests system for this purpose.
## Authors
In alphabetical order:
* Abhijit Menon-Sen
* Jane Threefoot
* Michael Wallace
Past contributors (in alphabetical order):
* Anna Bellandi (QA/testing)
* Britt Cole (documentation reviewer)
* Carlo Ascani (developer)
* Francesco Canovai (QA/testing)
* Gabriele Bartolini (architect)
* Gianni Ciolli (QA/testing)
* Giulio Calacoci (developer)
* Giuseppe Broccolo (developer)
* Jonathan Battiato (QA/testing)
* Leonardo Cecchi (developer)
* Marco Nenciarini (project leader)
* Niccolò Fei (QA/testing)
* Rubens Souza (QA/testing)
* Stefano Bianucci (developer)
## Links
- [check-barman][16]: a Nagios plugin for Barman, written by Holger
Hamann (MIT license)
- [puppet-barman][17]: Barman module for Puppet (GPL)
- [Tutorial on "How To Back Up, Restore, and Migrate PostgreSQL Databases with Barman on CentOS 7"][26], by Sadequl Hussain (available on DigitalOcean Community)
- [BarmanAPI][27]: RESTFul API for Barman, written by Mehmet Emin Karakaş (GPL)
## License and Contributions
Barman is the property of EnterpriseDB UK Limited and its code is
distributed under GNU General Public License 3.
© Copyright EnterpriseDB UK Limited 2011-2022
Barman has been partially funded through [4CaaSt][18], a research
project funded by the European Commission's Seventh Framework
programme.
Contributions to Barman are welcome, and will be listed in the
`AUTHORS` file. EnterpriseDB UK Limited requires that any contributions
provide a copyright assignment and a disclaimer of any work-for-hire
ownership claims from the employer of the developer. This lets us make
sure that all of the Barman distribution remains free code. Please
contact barman@enterprisedb.com for a copy of the relevant Copyright
Assignment Form.
barman-2.18/doc/manual/10-design.en.md 0000644 0006212 0006212 00000025645 14172556763 015550 0 ustar 0000000 0000000 \newpage
# Design and architecture
## Where to install Barman
One of the foundations of Barman is the ability to operate remotely from the database server, via the network.
Theoretically, you could have your Barman server located in a data centre in another part of the world, thousands of miles away from your PostgreSQL server.
Realistically, you do not want your Barman server to be too far from your PostgreSQL server, so that both backup and recovery times are kept under control.
Even though there is no _"one size fits all"_ way to setup Barman, there are a couple of recommendations that we suggest you abide by, in particular:
- Install Barman on a dedicated server
- Do not share the same storage with your PostgreSQL server
- Integrate Barman with your monitoring infrastructure [^nagios]
- Test everything before you deploy it to production
[^nagios]: Integration with Nagios/Icinga is straightforward thanks to the `barman check --nagios` command, one of the most important features of Barman and a true lifesaver.
A reasonable way to start modelling your disaster recovery architecture is to:
- design a couple of possible architectures in respect to PostgreSQL and Barman, such as:
1. same data centre
2. different data centre in the same metropolitan area
3. different data centre
- elaborate the pros and the cons of each hypothesis
- evaluate the single points of failure (SPOF) of your system, with cost-benefit analysis
- make your decision and implement the initial solution
Having said this, a very common setup for Barman is to be installed in the same data centre where your PostgreSQL servers are. In this case, the single point of failure is the data centre. Fortunately, the impact of such a SPOF can be alleviated thanks to two features that Barman provides to increase the number of backup tiers:
1. **geographical redundancy** (introduced in Barman 2.6)
2. **hook scripts**
With _geographical redundancy_, you can rely on a Barman instance that is located in a different data centre/availability zone to synchronise the entire content of the source Barman server. There's more: given that geo-redundancy can be configured in Barman not only at global level, but also at server level, you can create _hybrid installations_ of Barman where some servers are directly connected to the local PostgreSQL servers, and others are backing up subsets of different Barman installations (_cross-site backup_).
Figure \ref{georedundancy-design} below shows two availability zones (one in Europe and one in the US), each with a primary PostgreSQL server that is backed up in a local Barman installation, and relayed on the other Barman server (defined as _passive_) for multi-tier backup via rsync/SSH. Further information on geo-redundancy is available in the specific section.
{ width=80% }
Thanks to _hook scripts_ instead, backups of Barman can be exported on different media, such as _tape_ via `tar`, or locations, like an _S3 bucket_ in the Amazon cloud.
Remember that no decision is forever. You can start this way and adapt over time to the solution that suits you best. However, try and keep it simple to start with.
## One Barman, many PostgreSQL servers
Another relevant feature that was first introduced by Barman is support for multiple servers. Barman can store backup data coming from multiple PostgreSQL instances, even with different versions, in a centralised way. [^recver]
[^recver]: The same [requirements for PostgreSQL's PITR][requirements_recovery] apply for recovery, as detailed in the section _"Requirements for recovery"_.
As a result, you can model complex disaster recovery architectures, forming a "star schema", where PostgreSQL servers rotate around a central Barman server.
Every architecture makes sense in its own way. Choose the one that resonates with you, and most importantly, the one you trust, based on real experimentation and testing.
From this point forward, for the sake of simplicity, this guide will assume a basic architecture:
- one PostgreSQL instance (with host name `pg`)
- one backup server with Barman (with host name `backup`)
## Streaming backup vs rsync/SSH
Traditionally, Barman has always operated remotely via SSH, taking advantage of `rsync` for physical backup operations. Version 2.0 introduces native support for PostgreSQL's streaming replication protocol for backup operations, via `pg_basebackup`. [^fmatrix]
[^fmatrix]: Check in the "Feature matrix" which PostgreSQL versions support streaming replication backups with Barman.
Choosing one of these two methods is a decision you will need to make.
On a general basis, starting from Barman 2.0, backup over streaming replication is the recommended setup for PostgreSQL 9.4 or higher. Moreover, if you do not make use of tablespaces, backup over streaming can be used starting from PostgreSQL 9.2.
> **IMPORTANT:** \newline
> Because Barman transparently makes use of `pg_basebackup`, features such as incremental backup, parallel backup, deduplication, and network compression are currently not available. In this case, bandwidth limitation has some restrictions - compared to the traditional method via `rsync`.
Traditional backup via `rsync`/SSH is available for all versions of PostgreSQL starting from 8.3, and it is recommended in all cases where `pg_basebackup` limitations occur (for example, a very large database that can benefit from incremental backup and deduplication).
The reason why we recommend streaming backup is that, based on our experience, it is easier to setup than the traditional one. Also, streaming backup allows you to backup a PostgreSQL server on Windows[^windows], and makes life easier when working with Docker.
[^windows]: Backup of a PostgreSQL server on Windows is possible, but it is still experimental because it is not yet part of our continuous integration system. See section _"How to setup a Windows based server"_ for details.
## Standard archiving, WAL streaming ... or both
PostgreSQL's Point-In-Time-Recovery requires that transactional logs, also known as _xlog_ or WAL files, are stored alongside of base backups.
Traditionally, Barman has supported standard WAL file shipping through PostgreSQL's `archive_command` (usually via `rsync`/SSH, now via `barman-wal-archive` from the `barman-cli` package). With this method, WAL files are archived only when PostgreSQL _switches_ to a new WAL file. To keep it simple, this normally happens every 16MB worth of data changes.
Barman 1.6.0 introduces streaming of WAL files for PostgreSQL servers 9.2 or higher, as an additional method for transactional log archiving, through `pg_receivewal` (also known as `pg_receivexlog` before PostgreSQL 10). WAL streaming is able to reduce the risk of data loss, bringing RPO down to _near zero_ values.
Barman 2.0 introduces support for replication slots with PostgreSQL servers 9.4 or above, therefore allowing WAL streaming-only configurations. Moreover, you can now add Barman as a synchronous WAL receiver in your PostgreSQL 9.5 (or higher) cluster, and achieve **zero data loss** (RPO=0).
In some cases you have no choice and you are forced to use traditional archiving. In others, you can choose whether to use both or just WAL streaming.
Unless you have strong reasons not to do it, we recommend to use both channels, for maximum reliability and robustness.
## Two typical scenarios for backups
In order to make life easier for you, below we summarise the two most typical scenarios for a given PostgreSQL server in Barman.
Bear in mind that this is a decision that you must make for every single server that you decide to back up with Barman. This means that you can have heterogeneous setups within the same installation.
As mentioned before, we will only worry about the PostgreSQL server (`pg`) and the Barman server (`backup`). However, in real life, your architecture will most likely contain other technologies such as repmgr, pgBouncer, Nagios/Icinga, and so on.
### Scenario 1: Backup via streaming protocol
If you are using PostgreSQL 9.4 or higher, and your database falls under a general use case scenario, you will likely end up deciding on a streaming backup installation - see figure \ref{scenario1-design} below.
{ width=80% }
In this scenario, you will need to configure:
1. a standard connection to PostgreSQL, for management, coordination, and monitoring purposes
2. a streaming replication connection that will be used by both `pg_basebackup` (for base backup operations) and `pg_receivewal` (for WAL streaming)
This setup, in Barman's terminology, is known as **streaming-only** setup, as it does not require any SSH connection for backup and archiving operations. This is particularly suitable and extremely practical for Docker environments.
However, as mentioned before, you can configure standard archiving as well and implement a more robust architecture - see figure \ref{scenario1b-design} below.
{ width=80% }
This alternate approach requires:
- an additional SSH connection that allows the `postgres` user on the PostgreSQL server to connect as `barman` user on the Barman server
- the `archive_command` in PostgreSQL be configured to ship WAL files to Barman
This architecture is available also to PostgreSQL 9.2/9.3 users that do not use tablespaces.
### Scenario 2: Backup via `rsync`/SSH
The _traditional_ setup of `rsync` over SSH is the only available option for:
- PostgreSQL servers version 8.3, 8.4, 9.0 or 9.1
- PostgreSQL servers version 9.2 or 9.3 that are using tablespaces
- incremental backup, parallel backup and deduplication
- network compression during backups
- finer control of bandwidth usage, including on a tablespace basis
{ width=80% }
In this scenario, you will need to configure:
1. a standard connection to PostgreSQL for management, coordination, and monitoring purposes
2. an SSH connection for base backup operations to be used by `rsync` that allows the `barman` user on the Barman server to connect as `postgres` user on the PostgreSQL server
3. an SSH connection for WAL archiving to be used by the `archive_command` in PostgreSQL and that allows the `postgres` user on the PostgreSQL server to connect as `barman` user on the Barman server
Starting from PostgreSQL 9.2, you can add a streaming replication connection that is used for WAL streaming and significantly reduce RPO. This more robust implementation is depicted in figure \ref{scenario2b-design}.
{ width=80% }
barman-2.18/doc/manual/02-before_you_start.en.md 0000644 0006212 0006212 00000001751 14172556763 017643 0 ustar 0000000 0000000 \newpage
# Before you start
Before you start using Barman, it is fundamental that you get familiar
with PostgreSQL and the concepts around physical backups, Point-In-Time-Recovery and replication, such as base backups, WAL archiving, etc.
Below you can find a non exhaustive list of resources that we recommend for you to read:
- _PostgreSQL documentation_:
- [SQL Dump][sqldump][^pgdump]
- [File System Level Backup][physicalbackup]
- [Continuous Archiving and Point-in-Time Recovery (PITR)][pitr]
- [Reliability and the Write-Ahead Log][wal]
- _Book_: [PostgreSQL 10 Administration Cookbook][adminbook]
[^pgdump]: It is important that you know the difference between logical and physical backup, therefore between `pg_dump` and a tool like Barman.
Professional training on these topics is another effective way of
learning these concepts. At any time of the year you can find many
courses available all over the world, delivered by PostgreSQL
companies such as EnterpriseDB.
barman-2.18/doc/manual/25-streaming_backup.en.md 0000644 0006212 0006212 00000002565 14172556763 017617 0 ustar 0000000 0000000 ## Streaming backup
Barman can backup a PostgreSQL server using the streaming connection,
relying on `pg_basebackup`, a utility that has been available from
PostgreSQL 9.1.
> **IMPORTANT:** Barman requires that `pg_basebackup` is installed in
> the same server. For PostgreSQL 9.2 servers, you need the
> `pg_basebackup` of version 9.2 installed alongside with Barman. For
> PostgreSQL 9.3 and above, it is recommended to install the last
> available version of `pg_basebackup`, as it is back compatible. You
> can even install multiple versions of `pg_basebackup` on the Barman
> server and properly point to the specific version for a server,
> using the `path_prefix` option in the configuration file.
To successfully backup your server with the streaming connection, you
need to use `postgres` as your backup method:
``` ini
backup_method = postgres
```
> **IMPORTANT:** You will not be able to start a backup if WAL is not
> being correctly archived to Barman, either through the `archiver` or
> the `streaming_archiver`
To check if the server configuration is valid you can use the `barman
check` command:
``` bash
barman@backup$ barman check pg
```
To start a backup you can use the `barman backup` command:
``` bash
barman@backup$ barman backup pg
```
> **IMPORTANT:** `pg_basebackup` 9.4 or higher is required for
> tablespace support if you use the `postgres` backup method.
barman-2.18/doc/manual/21-preliminary_steps.en.md 0000644 0006212 0006212 00000021062 14172556763 020037 0 ustar 0000000 0000000 ## Preliminary steps
This section contains some preliminary steps that you need to
undertake before setting up your PostgreSQL server in Barman.
> **IMPORTANT:**
> Before you proceed, it is important that you have made your decision
> in terms of WAL archiving and backup strategies, as outlined in the
> _"Design and architecture"_ section. In particular, you should
> decide which WAL archiving methods to use, as well as the backup
> method.
### PostgreSQL connection
You need to make sure that the `backup` server can connect to
the PostgreSQL server on `pg` as superuser or, from PostgreSQL 10 or higher,
that the correct set of privileges are granted to the user that connects to
the database.
You can create a specific superuser in PostgreSQL, named `barman`, as follows:
``` bash
postgres@pg$ createuser -s -P barman
```
Or create a normal user with the required set of privileges as follows:
``` bash
postgres@pg$ createuser -P barman
```
``` sql
GRANT EXECUTE ON FUNCTION pg_start_backup(text, boolean, boolean) to barman;
GRANT EXECUTE ON FUNCTION pg_stop_backup() to barman;
GRANT EXECUTE ON FUNCTION pg_stop_backup(boolean, boolean) to barman;
GRANT EXECUTE ON FUNCTION pg_switch_wal() to barman;
GRANT EXECUTE ON FUNCTION pg_create_restore_point(text) to barman;
GRANT pg_read_all_settings TO barman;
GRANT pg_read_all_stats TO barman;
```
It is worth noting that without a real superuser, the `--force` option
of the `barman switch-wal` command will not work.
> **IMPORTANT:** The above `createuser` command will prompt for a password,
> which you are then advised to add to the `~barman/.pgpass` file
> on the `backup` server. For further information, please refer to
> ["The Password File" section in the PostgreSQL Documentation][pgpass].
This connection is required by Barman in order to coordinate its
activities with the server, as well as for monitoring purposes.
You can choose your favourite client authentication method among those
offered by PostgreSQL. More information can be found in the
["Client Authentication" section of the PostgreSQL Documentation][pghba].
Make sure you test the following command before proceeding:
``` bash
barman@backup$ psql -c 'SELECT version()' -U barman -h pg postgres
```
Write down the above information (user name, host name and database
name) and keep it for later. You will need it with in the `conninfo`
option for your server configuration, like in this example:
``` ini
[pg]
; ...
conninfo = host=pg user=barman dbname=postgres
```
> **NOTE:** Barman honours the `application_name` connection option
> for PostgreSQL servers 9.0 or higher.
### PostgreSQL WAL archiving and replication
Before you proceed, you need to properly configure PostgreSQL on `pg`
to accept streaming replication connections from the Barman
server. Please read the following sections in the PostgreSQL
documentation:
- [Role attributes][roles]
- [The pg_hba.conf file][authpghba]
- [Setting up standby servers using streaming replication][streamprot]
One configuration parameter that is crucially important is the
`wal_level` parameter. This parameter must be configured to ensure
that all the useful information necessary for a backup to be coherent
are included in the transaction log file.
``` ini
wal_level = 'replica'
```
For PostgreSQL 9.4 or higher, `wal_level` can also be set to `logical`,
in case logical decoding is needed.
For PostgreSQL versions older than 9.6, `wal_level` must be set to
`hot_standby`.
Restart the PostgreSQL server for the configuration to be refreshed.
### PostgreSQL streaming connection
If you plan to use WAL streaming or streaming backup, you need to
setup a streaming connection. We recommend creating a specific user in
PostgreSQL, named `streaming_barman`, as follows:
``` bash
postgres@pg$ createuser -P --replication streaming_barman
```
> **IMPORTANT:** The above command will prompt for a password,
> which you are then advised to add to the `~barman/.pgpass` file
> on the `backup` server. For further information, please refer to
> ["The Password File" section in the PostgreSQL Documentation][pgpass].
You can manually verify that the streaming connection works through
the following command:
``` bash
barman@backup$ psql -U streaming_barman -h pg \
-c "IDENTIFY_SYSTEM" \
replication=1
```
> **IMPORTANT:**
> Please make sure you are able to connect via streaming replication
> before going any further.
You also need to configure the `max_wal_senders` parameter in the
PostgreSQL configuration file. The number of WAL senders depends
on the PostgreSQL architecture you have implemented.
In this example, we are setting it to `2`:
``` ini
max_wal_senders = 2
```
This option represents the maximum number of concurrent streaming
connections that the server will be allowed to manage.
Another important parameter is `max_replication_slots`, which
represents the maximum number of replication slots [^replslot94]
that the server will be allowed to manage.
This parameter is needed if you are planning to
use the streaming connection to receive WAL files over the streaming
connection:
``` ini
max_replication_slots = 2
```
[^replslot94]: Replication slots have been introduced in PostgreSQL 9.4.
See section _"WAL Streaming / Replication slots"_ for
details.
The values proposed for `max_replication_slots` and `max_wal_senders`
must be considered as examples, and the values you will use in your
actual setup must be chosen after a careful evaluation of the
architecture. Please consult the PostgreSQL documentation for
guidelines and clarifications.
### SSH connections
SSH is a protocol and a set of tools that allows you to open a remote
shell to a remote server and copy files between the server and the local
system. You can find more documentation about SSH usage in the article
["SSH Essentials"][ssh_essentials] by Digital Ocean.
SSH key exchange is a very common practice that is used to implement
secure passwordless connections between users on different machines,
and it's needed to use `rsync` for WAL archiving and for backups.
> **NOTE:**
> This procedure is not needed if you plan to use the streaming
> connection only to archive transaction logs and backup your PostgreSQL
> server.
[ssh_essentials]: https://www.digitalocean.com/community/tutorials/ssh-essentials-working-with-ssh-servers-clients-and-keys
#### SSH configuration of postgres user
Unless you have done it before, you need to create an SSH key for the
PostgreSQL user. Log in as `postgres`, in the `pg` host and type:
``` bash
postgres@pg$ ssh-keygen -t rsa
```
As this key must be used to connect from hosts without providing a
password, no passphrase should be entered during the key pair
creation.
#### SSH configuration of barman user
As in the previous paragraph, you need to create an SSH key for the
Barman user. Log in as `barman` in the `backup` host and type:
``` bash
barman@backup$ ssh-keygen -t rsa
```
For the same reason, no passphrase should be entered.
#### From PostgreSQL to Barman
The SSH connection from the PostgreSQL server to the backup server is
needed to correctly archive WAL files using the `archive_command`
setting.
To successfully connect from the PostgreSQL server to the backup
server, the PostgreSQL public key has to be configured into the
authorized keys of the backup server for the `barman` user.
The public key to be authorized is stored inside the `postgres` user
home directory in a file named `.ssh/id_rsa.pub`, and its content
should be included in a file named `.ssh/authorized_keys` inside the
home directory of the `barman` user in the backup server. If the
`authorized_keys` file doesn't exist, create it using `600` as
permissions.
The following command should succeed without any output if the SSH key
pair exchange has been completed successfully:
``` bash
postgres@pg$ ssh barman@backup -C true
```
The value of the `archive_command` configuration parameter will be
discussed in the _"WAL archiving via archive_command section"_.
#### From Barman to PostgreSQL
The SSH connection between the backup server and the PostgreSQL server
is used for the traditional backup over rsync. Just as with the
connection from the PostgreSQL server to the backup server, we should
authorize the public key of the backup server in the PostgreSQL server
for the `postgres` user.
The content of the file `.ssh/id_rsa.pub` in the `barman` server should
be put in the file named `.ssh/authorized_keys` in the PostgreSQL
server. The permissions of that file should be `600`.
The following command should succeed without any output if the key
pair exchange has been completed successfully.
``` bash
barman@backup$ ssh postgres@pg -C true
```
barman-2.18/doc/manual/26-rsync_backup.en.md 0000644 0006212 0006212 00000001771 14172556763 016763 0 ustar 0000000 0000000 ## Backup with `rsync`/SSH
The backup over `rsync` was the only available method before 2.0, and
is currently the only backup method that supports the incremental
backup feature. Please consult the _"Features in detail"_ section for
more information.
To take a backup using `rsync` you need to put these parameters inside
the Barman server configuration file:
``` ini
backup_method = rsync
ssh_command = ssh postgres@pg
```
The `backup_method` option activates the `rsync` backup method, and
the `ssh_command` option is needed to correctly create an SSH
connection from the Barman server to the PostgreSQL server.
> **IMPORTANT:** You will not be able to start a backup if WAL is not
> being correctly archived to Barman, either through the `archiver` or
> the `streaming_archiver`
To check if the server configuration is valid you can use the `barman
check` command:
``` bash
barman@backup$ barman check pg
```
To take a backup use the `barman backup` command:
``` bash
barman@backup$ barman backup pg
```
barman-2.18/doc/manual/70-feature-matrix.en.md 0000644 0006212 0006212 00000004151 14172556763 017227 0 ustar 0000000 0000000 \newpage
\appendix
# Feature matrix
Below you will find a matrix of PostgreSQL versions and Barman features for backup and archiving:
| **Version** | **Backup with rsync/SSH** | **Backup with pg_basebackup** | **Standard WAL archiving** | **WAL Streaming** | **RPO=0** |
|:---------:|:---------------------:|:-------------------------:|:----------------------:|:----------------------:|:-------:|
| **14** | Yes | Yes | Yes | Yes | Yes |
| **13** | Yes | Yes | Yes | Yes | Yes |
| **12** | Yes | Yes | Yes | Yes | Yes |
| **11** | Yes | Yes | Yes | Yes | Yes |
| **10** | Yes | Yes | Yes | Yes | Yes |
| **9.6** | Yes | Yes | Yes | Yes | Yes |
| **9.5** | Yes | Yes | Yes | Yes | Yes ~(d)~ |
| **9.4** | Yes | Yes | Yes | Yes | Yes ~(d)~ |
| **9.3** | Yes | Yes ~(c)~ | Yes | Yes ~(b)~ | No |
| **9.2** | Yes | Yes ~(a)~~(c)~ | Yes | Yes ~(a)~~(b)~ | No |
| _9.1_ | Yes | No | Yes | No | No |
| _9.0_ | Yes | No | Yes | No | No |
| _8.4_ | Yes | No | Yes | No | No |
| _8.3_ | Yes | No | Yes | No | No |
**NOTE:**
a) `pg_basebackup` and `pg_receivexlog` 9.2 required
b) WAL streaming-only not supported (standard archiving required)
c) Backup of tablespaces not supported
d) When using `pg_receivexlog` 9.5, minor version 9.5.5 or higher required [^commitsync]
[^commitsync]: The commit ["Fix pg_receivexlog --synchronous"][49340627f9821e447f135455d942f7d5e96cae6d] is required (included in version 9.5.5)
It is required by Barman that `pg_basebackup` and `pg_receivewal`/`pg_receivexlog` of the same version of the PostgreSQL server (or higher) are installed on the same server where Barman resides. The only exception is that PostgreSQL 9.2 users are required to install version 9.2 of `pg_basebackup` and `pg_receivexlog` alongside with Barman.
>> **TIP:** We recommend that the last major, stable version of the PostgreSQL clients (e.g. 11) is installed on the Barman server if you plan to use backup and WAL archiving over streaming replication through `pg_basebackup` and `pg_receivewal`, for PostgreSQL 9.3 or higher servers.
>> **TIP:** For "RPO=0" architectures, it is recommended to have at least one synchronous standby server.
barman-2.18/doc/manual/01-intro.en.md 0000644 0006212 0006212 00000007657 14172556763 015435 0 ustar 0000000 0000000 \newpage
# Introduction
In a perfect world, there would be no need for a backup. However, it is
important, especially in business environments, to be prepared for
when the _"unexpected"_ happens. In a database scenario, the
unexpected could take any of the following forms:
- data corruption
- system failure (including hardware failure)
- human error
- natural disaster
In such cases, any ICT manager or DBA should be able to fix the
incident and recover the database in the shortest time possible. We
normally refer to this discipline as **disaster recovery**, and more
broadly *business continuity*.
Within business continuity, it is important to familiarise with two fundamental metrics, as defined by Wikipedia:
- [**Recovery Point Objective (RPO)**][rpo]: _"maximum targeted period in which data might be lost from an IT service due to a major incident"_
- [**Recovery Time Objective (RTO)**][rto]: _"the targeted duration of time and a service level within which a business process must be restored after a disaster (or disruption) in order to avoid unacceptable consequences associated with a break in business continuity"_
In a few words, RPO represents the maximum amount of data you can afford to lose, while RTO represents the maximum down-time you can afford for your service.
Understandably, we all want **RPO=0** (*"zero data loss"*) and **RTO=0** (*zero down-time*, utopia) - even if it is our grandmothers's recipe website.
In reality, a careful cost analysis phase allows you to determine your business continuity requirements.
Fortunately, with an open source stack composed of **Barman** and **PostgreSQL**, you can achieve RPO=0 thanks to synchronous streaming replication. RTO is more the focus of a *High Availability* solution, like [**repmgr**][repmgr]. Therefore, by integrating Barman and repmgr, you can dramatically reduce RTO to nearly zero.
Based on our experience at EnterpriseDB, we can confirm that PostgreSQL open source clusters with Barman and repmgr can easily achieve more than 99.99% uptime over a year, if properly configured and monitored.
In any case, it is important for us to emphasise more on cultural aspects related to disaster recovery, rather than the actual tools. Tools without human beings are useless.
Our mission with Barman is to promote a culture of disaster recovery that:
- focuses on backup procedures
- focuses even more on recovery procedures
- relies on education and training on strong theoretical and practical concepts of PostgreSQL's crash recovery, backup, Point-In-Time-Recovery, and replication for your team members
- promotes testing your backups (only a backup that is tested can be considered to be valid), either manually or automatically (be creative with Barman's hook scripts!)
- fosters regular practice of recovery procedures, by all members of your devops team (yes, developers too, not just system administrators and DBAs)
- solicites to regularly scheduled drills and disaster recovery simulations with the team every 3-6 months
- relies on continuous monitoring of PostgreSQL and Barman, and that is able to promptly identify any anomalies
Moreover, do everything you can to prepare yourself and your team for when the disaster happens (yes, *when*), because when it happens:
- It is going to be a Friday evening, most likely right when you are about to leave the office.
- It is going to be when you are on holiday (right in the middle of your cruise around the world) and somebody else has to deal with it.
- It is certainly going to be stressful.
- You will regret not being sure that the last available backup is valid.
- Unless you know how long it approximately takes to recover, every second will seems like forever.
Be prepared, don't be scared.
In 2011, with these goals in mind, 2ndQuadrant started the development of
Barman, now one of the most used backup tools for PostgreSQL. Barman is an acronym for "Backup and Recovery Manager".
Currently, Barman works only on Linux and Unix operating systems.
barman-2.18/doc/manual/41-global-commands.en.md 0000644 0006212 0006212 00000004465 14172556763 017337 0 ustar 0000000 0000000 \newpage
# General commands
Barman has many commands and, for the sake of exposition, we can
organize them by scope.
The scope of the **general commands** is the entire Barman server,
that can backup many PostgreSQL servers. **Server commands**, instead,
act only on a specified server. **Backup commands** work on a backup,
which is taken from a certain server.
The following list includes the general commands.
## `cron`
`barman` doesn't include a long-running daemon or service file (there's
nothing to `systemctl start`, `service start`, etc.). Instead, the `barman
cron` subcommand is provided to perform `barman`'s background
"steady-state" backup operations.
You can perform maintenance operations, on both WAL files and backups,
using the `cron` command:
``` bash
barman cron
```
> **NOTE:**
> This command should be executed in a _cron script_. Our
> recommendation is to schedule `barman cron` to run every minute. If
> you installed Barman using the rpm or debian package, a cron entry
> running on every minute will be created for you.
`barman cron` executes WAL archiving operations concurrently on a
server basis, and this also enforces retention policies on those
servers that have:
- `retention_policy` not empty and valid;
- `retention_policy_mode` set to `auto`.
The `cron` command ensures that WAL streaming is started for those
servers that have requested it, by transparently executing the
`receive-wal` command.
In order to stop the operations started by the `cron` command, comment out
the cron entry and execute:
```bash
barman receive-wal --stop SERVER_NAME
```
You might want to check `barman list-servers` to make sure you get all of
your servers.
## `diagnose`
The `diagnose` command creates a JSON report useful for diagnostic and
support purposes. This report contains information for all configured
servers.
> **IMPORTANT:**
> Even if the diagnose is written in JSON and that format is thought
> to be machine readable, its structure is not to be considered part
> of the interface. Format can change between different Barman versions.
## `list-servers`
You can display the list of active servers that have been configured
for your backup system with:
``` bash
barman list-servers
```
A machine readable output can be obtained with the `--minimal` option:
``` bash
barman list-servers --minimal
```
barman-2.18/doc/manual/99-references.en.md 0000644 0006212 0006212 00000006460 14172556763 016433 0 ustar 0000000 0000000
[rpo]: https://en.wikipedia.org/wiki/Recovery_point_objective
[rto]: https://en.wikipedia.org/wiki/Recovery_time_objective
[repmgr]: http://www.repmgr.org/
[sqldump]: https://www.postgresql.org/docs/current/static/backup-dump.html
[physicalbackup]: https://www.postgresql.org/docs/current/static/backup-file.html
[pitr]: https://www.postgresql.org/docs/current/static/continuous-archiving.html
[adminbook]: https://www.2ndquadrant.com/en/books/postgresql-10-administration-cookbook/
[wal]: https://www.postgresql.org/docs/current/static/wal.html
[49340627f9821e447f135455d942f7d5e96cae6d]: https://git.postgresql.org/gitweb/?p=postgresql.git;a=commit;h=49340627f9821e447f135455d942f7d5e96cae6d
[requirements_recovery]: https://www.postgresql.org/docs/current/static/warm-standby.html#STANDBY-PLANNING
[yumpgdg]: http://yum.postgresql.org/
[aptpgdg]: http://apt.postgresql.org/
[aptpgdgwiki]: https://wiki.postgresql.org/wiki/Apt
[epel]: http://fedoraproject.org/wiki/EPEL
[man5]: https://docs.pgbarman.org/barman.5.html
[setup_user]: https://docs.python.org/3/install/index.html#alternate-installation-the-user-scheme
[pypi]: https://pypi.python.org/pypi/barman/
[pgpass]: https://www.postgresql.org/docs/current/static/libpq-pgpass.html
[pghba]: http://www.postgresql.org/docs/current/static/client-authentication.html
[authpghba]: http://www.postgresql.org/docs/current/static/auth-pg-hba-conf.html
[streamprot]: http://www.postgresql.org/docs/current/static/protocol-replication.html
[roles]: http://www.postgresql.org/docs/current/static/role-attributes.html
[replication-slots]: https://www.postgresql.org/docs/current/static/warm-standby.html#STREAMING-REPLICATION-SLOTS
[synch]: http://www.postgresql.org/docs/current/static/warm-standby.html#SYNCHRONOUS-REPLICATION
[target]: https://www.postgresql.org/docs/current/static/recovery-target-settings.html
[2ndqrpmrepo]: https://rpm.2ndquadrant.com/
[2ndqdebrepo]: https://apt.2ndquadrant.com/
[boto3]: https://github.com/boto/boto3
[boto3creds]: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html
[azure-identity]: https://docs.microsoft.com/en-us/python/api/azure-identity/?view=azure-python
[azure-storage-blob]: https://docs.microsoft.com/en-us/python/api/azure-storage-blob/?view=azure-python
[azure-storage-auth]: https://docs.microsoft.com/en-us/azure/storage/blobs/authorize-data-operations-cli#set-environment-variables-for-authorization-parameters
[3]: http://github.com/EnterpriseDB/barman
[8]: http://en.wikipedia.org/wiki/Hard_link
[9]: https://github.com/2ndquadrant-it/pgespresso
[11]: http://www.pgbarman.org/
[12]: http://www.pgbarman.org/support/
[13]: https://www.enterprisedb.com/
[14]: http://www.pgbarman.org/faq/
[15]: http://blog.2ndquadrant.com/tag/barman/
[16]: https://github.com/hamann/check-barman
[17]: https://github.com/2ndquadrant-it/puppet-barman
[18]: http://4caast.morfeo-project.org/
[20]: http://www.postgresql.org/docs/current/static/functions-admin.html
[24]: http://www.postgresql.org/docs/current/static/warm-standby.html#STREAMING-REPLICATION
[25]: http://www.postgresql.org/docs/current/static/app-pgreceivewal.html
[26]: https://goo.gl/218Ghl
[27]: https://github.com/emin100/barmanapi
[31]: http://www.postgresql.org/
barman-2.18/doc/manual/65-troubleshooting.en.md 0000644 0006212 0006212 00000003304 14172556763 017524 0 ustar 0000000 0000000 \newpage
# Troubleshooting
## Diagnose a Barman installation
You can gather important information about the status of all
the configured servers using:
``` bash
barman diagnose
```
The `diagnose` command output is a full snapshot of the barman server,
providing useful information, such as global configuration, SSH version,
Python version, `rsync` version, PostgreSQL clients version,
as well as current configuration and status of all servers.
The `diagnose` command is extremely useful for troubleshooting problems,
as it gives a global view on the status of your Barman installation.
## Requesting help
Although Barman is extensively documented, there are a lot of scenarios that
are not covered.
For any questions about Barman and disaster recovery scenarios using Barman,
you can reach the dev team using the community mailing list:
https://groups.google.com/group/pgbarman
or the IRC channel on freenode:
irc://irc.freenode.net/barman
In the event you discover a bug, you can open a ticket using Github:
https://github.com/EnterpriseDB/barman/issues
EnterpriseDB provides professional support for Barman, including 24/7 service.
### Submitting a bug
Barman has been extensively tested and is currently being used in
several production environments. However, as any software, Barman is
not bug free.
If you discover a bug, please follow this procedure:
- execute the `barman diagnose` command
- file a bug through the Github issue tracker, by attaching the
output obtained by the diagnostics command above (`barman
diagnose`)
> **WARNING:**
> Be careful when submitting the output of the diagnose command
> as it might disclose information that are potentially dangerous
> from a security point of view.
barman-2.18/doc/barman-cloud-restore.1 0000644 0006212 0006212 00000010063 14172556763 015754 0 ustar 0000000 0000000 .\" Automatically generated by Pandoc 2.2.1
.\"
.TH "BARMAN\-CLOUD\-RESTORE" "1" "January 21, 2022" "Barman User manuals" "Version 2.18"
.hy
.SH NAME
.PP
barman\-cloud\-restore \- Restore a PostgreSQL backup from the Cloud
.SH SYNOPSIS
.PP
barman\-cloud\-restore [\f[I]OPTIONS\f[]] \f[I]SOURCE_URL\f[]
\f[I]SERVER_NAME\f[] \f[I]BACKUP_ID\f[] \f[I]RECOVERY_DIR\f[]
.SH DESCRIPTION
.PP
This script can be used to download a backup previouslymade with
\f[C]barman\-cloud\-backup\f[] command.
Currently AWS S3 and Azure Blob Storage are supported.
.PP
This script and Barman are administration tools for disaster recovery of
PostgreSQL servers written in Python and maintained by EnterpriseDB.
.SH POSITIONAL ARGUMENTS
.TP
.B SOURCE_URL
URL of the cloud source, such as a bucket in AWS S3.
For example: \f[C]s3://BUCKET_NAME/path/to/folder\f[] (where
\f[C]BUCKET_NAME\f[] is the bucket you have created in AWS).
.RS
.RE
.TP
.B SERVER_NAME
the name of the server as configured in Barman.
.RS
.RE
.TP
.B BACKUP_ID
the ID of the backup to restore
.RS
.RE
.TP
.B RECOVERY_DIR
the path to a local directory for recovery (used as PGDATA).
.RS
.RE
.SH OPTIONS
.TP
.B \-h, \[en]help
show a help message and exit
.RS
.RE
.TP
.B \-V, \[en]version
show program's version number and exit
.RS
.RE
.TP
.B \-v, \[en]verbose
increase output verbosity (e.g., \-vv is more than \-v)
.RS
.RE
.TP
.B \-q, \[en]quiet
decrease output verbosity (e.g., \-qq is less than \-q)
.RS
.RE
.TP
.B \-t, \[en]test
test connectivity to the cloud destination and exit
.RS
.RE
.TP
.B \[en]tablespace NAME:LOCATION
extract the named tablespace to the given directory instead of its
original location (you may repeat the option for multiple tablespaces)
.RS
.RE
.TP
.B \[en]cloud\-provider {aws\-s3,azure\-blob\-storage}
the cloud provider to which the backup should be uploaded
.RS
.RE
.TP
.B \-P, \[en]profile
profile name (e.g.\ INI section in AWS credentials file)
.RS
.RE
.TP
.B \[en]endpoint\-url
override the default S3 URL construction mechanism by specifying an
endpoint.
.RS
.RE
.TP
.B \[en]credential {azure\-cli,managed\-identity}
optionally specify the type of credential to use when authenticating
with Azure Blob Storage.
If omitted then the credential will be obtained from the environment.
If no credentials can be found in the environment then the default Azure
authentication flow will be used.
.RS
.RE
.SH REFERENCES
.PP
For Boto:
.IP \[bu] 2
https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html
.PP
For AWS:
.IP \[bu] 2
http://docs.aws.amazon.com/cli/latest/userguide/cli\-chap\-getting\-set\-up.html
.IP \[bu] 2
http://docs.aws.amazon.com/cli/latest/userguide/cli\-chap\-getting\-started.html.
.PP
For Azure Blob Storage:
.IP \[bu] 2
https://docs.microsoft.com/en\-us/azure/storage/blobs/authorize\-data\-operations\-cli#set\-environment\-variables\-for\-authorization\-parameters
.IP \[bu] 2
https://docs.microsoft.com/en\-us/python/api/azure\-storage\-blob/?view=azure\-python
.SH DEPENDENCIES
.PP
If using \f[C]\-\-cloud\-provider=aws\-s3\f[]:
.IP \[bu] 2
boto3
.PP
If using \f[C]\-\-cloud\-provider=azure\-blob\-storage\f[]:
.IP \[bu] 2
azure\-storage\-blob
.IP \[bu] 2
azure\-identity (optional, if you wish to use DefaultAzureCredential)
.SH EXIT STATUS
.TP
.B 0
Success
.RS
.RE
.TP
.B 1
The restore was not successful
.RS
.RE
.TP
.B 2
The connection to the cloud provider failed
.RS
.RE
.TP
.B 3
There was an error in the command input
.RS
.RE
.TP
.B Other non\-zero codes
Failure
.RS
.RE
.SH BUGS
.PP
Barman has been extensively tested, and is currently being used in
several production environments.
However, we cannot exclude the presence of bugs.
.PP
Any bug can be reported via the Github issue tracker.
.SH RESOURCES
.IP \[bu] 2
Homepage:
.IP \[bu] 2
Documentation:
.IP \[bu] 2
Professional support:
.SH COPYING
.PP
Barman is the property of EnterpriseDB UK Limited and its code is
distributed under GNU General Public License v3.
.PP
© Copyright EnterpriseDB UK Limited 2011\-2022
.SH AUTHORS
EnterpriseDB .
barman-2.18/doc/barman.5 0000644 0006212 0006212 00000061637 14172556763 013210 0 ustar 0000000 0000000 .\" Automatically generated by Pandoc 2.2.1
.\"
.TH "BARMAN" "5" "January 21, 2022" "Barman User manuals" "Version 2.18"
.hy
.SH NAME
.PP
barman \- Backup and Recovery Manager for PostgreSQL
.SH DESCRIPTION
.PP
Barman is an administration tool for disaster recovery of PostgreSQL
servers written in Python and maintained by EnterpriseDB.
Barman can perform remote backups of multiple servers in business
critical environments and helps DBAs during the recovery phase.
.SH CONFIGURATION FILE LOCATIONS
.PP
The system\-level Barman configuration file is located at
.IP
.nf
\f[C]
/etc/barman.conf
\f[]
.fi
.PP
or
.IP
.nf
\f[C]
/etc/barman/barman.conf
\f[]
.fi
.PP
and is overridden on a per\-user level by
.IP
.nf
\f[C]
$HOME/.barman.conf
\f[]
.fi
.SH CONFIGURATION FILE SYNTAX
.PP
The Barman configuration file is a plain \f[C]INI\f[] file.
There is a general section called \f[C][barman]\f[] and a section
\f[C][servername]\f[] for each server you want to backup.
Rows starting with \f[C];\f[] are comments.
.SH CONFIGURATION FILE DIRECTORY
.PP
Barman supports the inclusion of multiple configuration files, through
the \f[C]configuration_files_directory\f[] option.
Included files must contain only server specifications, not global
configurations.
If the value of \f[C]configuration_files_directory\f[] is a directory,
Barman reads all files with \f[C]\&.conf\f[] extension that exist in
that folder.
For example, if you set it to \f[C]/etc/barman.d\f[], you can specify
your PostgreSQL servers placing each section in a separate
\f[C]\&.conf\f[] file inside the \f[C]/etc/barman.d\f[] folder.
.SH OPTIONS
.TP
.B active
When set to \f[C]true\f[] (default), the server is in full operational
state.
When set to \f[C]false\f[], the server can be used for diagnostics, but
any operational command such as backup execution or WAL archiving is
temporarily disabled.
When adding a new server to Barman, we suggest setting active=false at
first, making sure that barman check shows no problems, and only then
activating the server.
This will avoid spamming the Barman logs with errors during the initial
setup.
.RS
.RE
.TP
.B archiver
This option allows you to activate log file shipping through
PostgreSQL\[aq]s \f[C]archive_command\f[] for a server.
If set to \f[C]true\f[] (default), Barman expects that continuous
archiving for a server is in place and will activate checks as well as
management (including compression) of WAL files that Postgres deposits
in the \f[I]incoming\f[] directory.
Setting it to \f[C]false\f[], will disable standard continuous archiving
for a server.
Global/Server.
.RS
.RE
.TP
.B archiver_batch_size
This option allows you to activate batch processing of WAL files for the
\f[C]archiver\f[] process, by setting it to a value > 0.
Otherwise, the traditional unlimited processing of the WAL queue is
enabled.
When batch processing is activated, the \f[C]archive\-wal\f[] process
would limit itself to maximum \f[C]archiver_batch_size\f[] WAL segments
per single run.
Integer.
Global/Server.
.RS
.RE
.TP
.B backup_directory
Directory where backup data for a server will be placed.
Server.
.RS
.RE
.TP
.B backup_method
Configure the method barman used for backup execution.
If set to \f[C]rsync\f[] (default), barman will execute backup using the
\f[C]rsync\f[] command over SSH (requires \f[C]ssh_command\f[]).
If set to \f[C]postgres\f[] barman will use the \f[C]pg_basebackup\f[]
command to execute the backup.
If set to \f[C]local\-rsync\f[], barman will assume to be running on the
same server as the the PostgreSQL instance and with the same user, then
execute \f[C]rsync\f[] for the file system copy.
Global/Server.
.RS
.RE
.TP
.B backup_options
This option allows you to control the way Barman interacts with
PostgreSQL for backups.
It is a comma\-separated list of values that accepts the following
options:
.RS
.IP \[bu] 2
\f[C]exclusive_backup\f[] (default when
\f[C]backup_method\ =\ rsync\f[]): \f[C]barman\ backup\f[] executes
backup operations using the standard exclusive backup approach
(technically through \f[C]pg_start_backup\f[] and
\f[C]pg_stop_backup\f[])
.IP \[bu] 2
\f[C]concurrent_backup\f[] (default when
\f[C]backup_method\ =\ postgres\f[]): if using PostgreSQL 9.2, 9.3, 9.4,
and 9.5, Barman requires the \f[C]pgespresso\f[] module to be installed
on the PostgreSQL server and can be used to perform a backup from a
standby server.
Starting from PostgreSQL 9.6, Barman uses the new PostgreSQL API to
perform backups from a standby server.
.IP \[bu] 2
\f[C]external_configuration\f[]: if present, any warning regarding
external configuration files is suppressed during the execution of a
backup.
.PP
Note that \f[C]exclusive_backup\f[] and \f[C]concurrent_backup\f[] are
mutually exclusive.
Global/Server.
.RE
.TP
.B bandwidth_limit
This option allows you to specify a maximum transfer rate in kilobytes
per second.
A value of zero specifies no limit (default).
Global/Server.
.RS
.RE
.TP
.B barman_home
Main data directory for Barman.
Global.
.RS
.RE
.TP
.B barman_lock_directory
Directory for locks.
Default: \f[C]%(barman_home)s\f[].
Global.
.RS
.RE
.TP
.B basebackup_retry_sleep
Number of seconds of wait after a failed copy, before retrying Used
during both backup and recovery operations.
Positive integer, default 30.
Global/Server.
.RS
.RE
.TP
.B basebackup_retry_times
Number of retries of base backup copy, after an error.
Used during both backup and recovery operations.
Positive integer, default 0.
Global/Server.
.RS
.RE
.TP
.B basebackups_directory
Directory where base backups will be placed.
Server.
.RS
.RE
.TP
.B check_timeout
Maximum execution time, in seconds per server, for a barman check
command.
Set to 0 to disable the timeout.
Positive integer, default 30.
Global/Server.
.RS
.RE
.TP
.B compression
Standard compression algorithm applied to WAL files.
Possible values are: \f[C]gzip\f[] (requires \f[C]gzip\f[] to be
installed on the system), \f[C]bzip2\f[] (requires \f[C]bzip2\f[]),
\f[C]pigz\f[] (requires \f[C]pigz\f[]), \f[C]pygzip\f[] (Python\[aq]s
internal gzip compressor) and \f[C]pybzip2\f[] (Python\[aq]s internal
bzip2 compressor).
Global/Server.
.RS
.RE
.TP
.B conninfo
Connection string used by Barman to connect to the Postgres server.
This is a libpq connection string, consult the PostgreSQL
manual (https://www.postgresql.org/docs/current/static/libpq-connect.html#LIBPQ-CONNSTRING)
for more information.
Commonly used keys are: host, hostaddr, port, dbname, user, password.
Server.
.RS
.RE
.TP
.B create_slot
When set to \f[C]auto\f[] and \f[C]slot_name\f[] is defined, Barman
automatically attempts to create the replication slot if not present.
When set to \f[C]manual\f[] (default), the replication slot needs to be
manually created.
Global/Server.
.RS
.RE
.TP
.B custom_compression_filter
Customised compression algorithm applied to WAL files.
Global/Server.
.RS
.RE
.TP
.B custom_compression_magic
Customised compression magic which is checked in the beginning of a WAL
file to select the custom algorithm.
If you are using a custom compression filter then setting this will
prevent barman from applying the custom compression to WALs which have
been pre\-compressed with that compression.
If you do not configure this then custom compression will still be
applied but any pre\-compressed WAL files will be compressed again
during WAL archive.
Global/Server.
.RS
.RE
.TP
.B custom_decompression_filter
Customised decompression algorithm applied to compressed WAL files; this
must match the compression algorithm.
Global/Server.
.RS
.RE
.TP
.B description
A human readable description of a server.
Server.
.RS
.RE
.TP
.B errors_directory
Directory that contains WAL files that contain an error; usually this is
related to a conflict with an existing WAL file (e.g.
a WAL file that has been archived after a streamed one).
.RS
.RE
.TP
.B forward_config_path
Parameter which determines whether a passive node should forward its
configuration file path to its primary node during cron or sync\-info
commands.
Set to true if you are invoking barman with the \f[C]\-c/\-\-config\f[]
option and your configuration is in the same place on both the passive
and primary barman servers.
Defaults to false.
.RS
.RE
.TP
.B immediate_checkpoint
This option allows you to control the way PostgreSQL handles checkpoint
at the start of the backup.
If set to \f[C]false\f[] (default), the I/O workload for the checkpoint
will be limited, according to the \f[C]checkpoint_completion_target\f[]
setting on the PostgreSQL server.
If set to \f[C]true\f[], an immediate checkpoint will be requested,
meaning that PostgreSQL will complete the checkpoint as soon as
possible.
Global/Server.
.RS
.RE
.TP
.B incoming_wals_directory
Directory where incoming WAL files are archived into.
Requires \f[C]archiver\f[] to be enabled.
Server.
.RS
.RE
.TP
.B last_backup_maximum_age
This option identifies a time frame that must contain the latest backup.
If the latest backup is older than the time frame, barman check command
will report an error to the user.
If empty (default), latest backup is always considered valid.
Syntax for this option is: "i (DAYS | WEEKS | MONTHS)" where i is a
integer greater than zero, representing the number of days | weeks |
months of the time frame.
Global/Server.
.RS
.RE
.TP
.B last_backup_minimum_size
This option identifies lower limit to the acceptable size of the latest
successful backup.
If the latest backup is smaller than the specified size, barman check
command will report an error to the user.
If empty (default), latest backup is always considered valid.
Syntax for this option is: "i (k|Ki|M|Mi|G|Gi|T|Ti)" where i is an
integer greater than zero, with an optional SI or IEC suffix.
k=kilo=1000, Ki=Kibi=1024 and so forth.
Note that the suffix is case\-sensitive.
Global/Server.
.RS
.RE
.TP
.B last_wal_maximum_age
This option identifies a time frame that must contain the latest WAL
file archived.
If the latest WAL file is older than the time frame, barman check
command will report an error to the user.
If empty (default), the age of the WAL files is not checked.
Syntax is the same as last_backup_maximum_age (above).
Global/Server.
log_file
.RS
.RE
Location of Barman\[aq]s log file.
Global.
.RS
.RE
.TP
.B log_level
Level of logging (DEBUG, INFO, WARNING, ERROR, CRITICAL).
Global.
.RS
.RE
.TP
.B max_incoming_wals_queue
Maximum number of WAL files in the incoming queue (in both streaming and
archiving pools) that are allowed before barman check returns an error
(that does not block backups).
Global/Server.
Default: None (disabled).
.RS
.RE
.TP
.B minimum_redundancy
Minimum number of backups to be retained.
Default 0.
Global/Server.
.RS
.RE
.TP
.B network_compression
This option allows you to enable data compression for network transfers.
If set to \f[C]false\f[] (default), no compression is used.
If set to \f[C]true\f[], compression is enabled, reducing network usage.
Global/Server.
.RS
.RE
.TP
.B parallel_jobs
This option controls how many parallel workers will copy files during a
backup or recovery command.
Default 1.
Global/Server.
For backup purposes, it works only when \f[C]backup_method\f[] is
\f[C]rsync\f[].
.RS
.RE
.TP
.B path_prefix
One or more absolute paths, separated by colon, where Barman looks for
executable files.
The paths specified in \f[C]path_prefix\f[] are tried before the ones
specified in \f[C]PATH\f[] environment variable.
Global/server.
.RS
.RE
.TP
.B post_archive_retry_script
Hook script launched after a WAL file is archived by maintenance.
Being this a \f[I]retry\f[] hook script, Barman will retry the execution
of the script until this either returns a SUCCESS (0), an ABORT_CONTINUE
(62) or an ABORT_STOP (63) code.
In a post archive scenario, ABORT_STOP has currently the same effects as
ABORT_CONTINUE.
Global/Server.
.RS
.RE
.TP
.B post_archive_script
Hook script launched after a WAL file is archived by maintenance, after
\[aq]post_archive_retry_script\[aq].
Global/Server.
.RS
.RE
.TP
.B post_backup_retry_script
Hook script launched after a base backup.
Being this a \f[I]retry\f[] hook script, Barman will retry the execution
of the script until this either returns a SUCCESS (0), an ABORT_CONTINUE
(62) or an ABORT_STOP (63) code.
In a post backup scenario, ABORT_STOP has currently the same effects as
ABORT_CONTINUE.
Global/Server.
.RS
.RE
.TP
.B post_backup_script
Hook script launched after a base backup, after
\[aq]post_backup_retry_script\[aq].
Global/Server.
.RS
.RE
.TP
.B post_delete_retry_script
Hook script launched after the deletion of a backup.
Being this a \f[I]retry\f[] hook script, Barman will retry the execution
of the script until this either returns a SUCCESS (0), an ABORT_CONTINUE
(62) or an ABORT_STOP (63) code.
In a post delete scenario, ABORT_STOP has currently the same effects as
ABORT_CONTINUE.
Global/Server.
.RS
.RE
.TP
.B post_delete_script
Hook script launched after the deletion of a backup, after
\[aq]post_delete_retry_script\[aq].
Global/Server.
.RS
.RE
.TP
.B post_recovery_retry_script
Hook script launched after a recovery.
Being this a \f[I]retry\f[] hook script, Barman will retry the execution
of the script until this either returns a SUCCESS (0), an ABORT_CONTINUE
(62) or an ABORT_STOP (63) code.
In a post recovery scenario, ABORT_STOP has currently the same effects
as ABORT_CONTINUE.
Global/Server.
.RS
.RE
.TP
.B post_recovery_script
Hook script launched after a recovery, after
\[aq]post_recovery_retry_script\[aq].
Global/Server.
.RS
.RE
.TP
.B post_wal_delete_retry_script
Hook script launched after the deletion of a WAL file.
Being this a \f[I]retry\f[] hook script, Barman will retry the execution
of the script until this either returns a SUCCESS (0), an ABORT_CONTINUE
(62) or an ABORT_STOP (63) code.
In a post delete scenario, ABORT_STOP has currently the same effects as
ABORT_CONTINUE.
Global/Server.
.RS
.RE
.TP
.B post_wal_delete_script
Hook script launched after the deletion of a WAL file, after
\[aq]post_wal)delete_retry_script\[aq].
Global/Server.
.RS
.RE
.TP
.B pre_archive_retry_script
Hook script launched before a WAL file is archived by maintenance, after
\[aq]pre_archive_script\[aq].
Being this a \f[I]retry\f[] hook script, Barman will retry the execution
of the script until this either returns a SUCCESS (0), an ABORT_CONTINUE
(62) or an ABORT_STOP (63) code.
Returning ABORT_STOP will propagate the failure at a higher level and
interrupt the WAL archiving operation.
Global/Server.
.RS
.RE
.TP
.B pre_archive_script
Hook script launched before a WAL file is archived by maintenance.
Global/Server.
.RS
.RE
.TP
.B pre_backup_retry_script
Hook script launched before a base backup, after
\[aq]pre_backup_script\[aq].
Being this a \f[I]retry\f[] hook script, Barman will retry the execution
of the script until this either returns a SUCCESS (0), an ABORT_CONTINUE
(62) or an ABORT_STOP (63) code.
Returning ABORT_STOP will propagate the failure at a higher level and
interrupt the backup operation.
Global/Server.
.RS
.RE
.TP
.B pre_backup_script
Hook script launched before a base backup.
Global/Server.
.RS
.RE
.TP
.B pre_delete_retry_script
Hook script launched before the deletion of a backup, after
\[aq]pre_delete_script\[aq].
Being this a \f[I]retry\f[] hook script, Barman will retry the execution
of the script until this either returns a SUCCESS (0), an ABORT_CONTINUE
(62) or an ABORT_STOP (63) code.
Returning ABORT_STOP will propagate the failure at a higher level and
interrupt the backup deletion.
Global/Server.
.RS
.RE
.TP
.B pre_delete_script
Hook script launched before the deletion of a backup.
Global/Server.
.RS
.RE
.TP
.B pre_recovery_retry_script
Hook script launched before a recovery, after
\[aq]pre_recovery_script\[aq].
Being this a \f[I]retry\f[] hook script, Barman will retry the execution
of the script until this either returns a SUCCESS (0), an ABORT_CONTINUE
(62) or an ABORT_STOP (63) code.
Returning ABORT_STOP will propagate the failure at a higher level and
interrupt the recover operation.
Global/Server.
.RS
.RE
.TP
.B pre_recovery_script
Hook script launched before a recovery.
Global/Server.
.RS
.RE
.TP
.B pre_wal_delete_retry_script
Hook script launched before the deletion of a WAL file, after
\[aq]pre_wal_delete_script\[aq].
Being this a \f[I]retry\f[] hook script, Barman will retry the execution
of the script until this either returns a SUCCESS (0), an ABORT_CONTINUE
(62) or an ABORT_STOP (63) code.
Returning ABORT_STOP will propagate the failure at a higher level and
interrupt the WAL file deletion.
Global/Server.
.RS
.RE
.TP
.B pre_wal_delete_script
Hook script launched before the deletion of a WAL file.
Global/Server.
.RS
.RE
.TP
.B primary_ssh_command
Parameter that identifies a Barman server as \f[C]passive\f[].
In a passive node, the source of a backup server is a Barman
installation rather than a PostgreSQL server.
If \f[C]primary_ssh_command\f[] is specified, Barman uses it to
establish a connection with the primary server.
Empty by default, it can also be set globally.
.RS
.RE
.TP
.B recovery_options
Options for recovery operations.
Currently only supports \f[C]get\-wal\f[].
\f[C]get\-wal\f[] activates generation of a basic
\f[C]restore_command\f[] in the resulting recovery configuration that
uses the \f[C]barman\ get\-wal\f[] command to fetch WAL files directly
from Barman\[aq]s archive of WALs.
Comma separated list of values, default empty.
Global/Server.
.RS
.RE
.TP
.B retention_policy
Policy for retention of periodic backups and archive logs.
If left empty, retention policies are not enforced.
For redundancy based retention policy use "REDUNDANCY i" (where i is an
integer > 0 and defines the number of backups to retain).
For recovery window retention policy use "RECOVERY WINDOW OF i DAYS" or
"RECOVERY WINDOW OF i WEEKS" or "RECOVERY WINDOW OF i MONTHS" where i is
a positive integer representing, specifically, the number of days, weeks
or months to retain your backups.
For more detailed information, refer to the official documentation.
Default value is empty.
Global/Server.
.RS
.RE
.TP
.B retention_policy_mode
Currently only "auto" is implemented.
Global/Server.
.RS
.RE
.TP
.B reuse_backup
This option controls incremental backup support.
Global/Server.
Possible values are:
.RS
.IP \[bu] 2
\f[C]off\f[]: disabled (default);
.IP \[bu] 2
\f[C]copy\f[]: reuse the last available backup for a server and create a
copy of the unchanged files (reduce backup time);
.IP \[bu] 2
\f[C]link\f[]: reuse the last available backup for a server and create a
hard link of the unchanged files (reduce backup time and space).
Requires operating system and file system support for hard links.
.RE
.TP
.B slot_name
Physical replication slot to be used by the \f[C]receive\-wal\f[]
command when \f[C]streaming_archiver\f[] is set to \f[C]on\f[].
Requires PostgreSQL >= 9.4.
Global/Server.
Default: None (disabled).
.RS
.RE
.TP
.B ssh_command
Command used by Barman to login to the Postgres server via ssh.
Server.
.RS
.RE
.TP
.B streaming_archiver
This option allows you to use the PostgreSQL\[aq]s streaming protocol to
receive transaction logs from a server.
If set to \f[C]on\f[], Barman expects to find \f[C]pg_receivewal\f[]
(known as \f[C]pg_receivexlog\f[] prior to PostgreSQL 10) in the PATH
(see \f[C]path_prefix\f[] option) and that streaming connection for the
server is working.
This activates connection checks as well as management (including
compression) of WAL files.
If set to \f[C]off\f[] (default) barman will rely only on continuous
archiving for a server WAL archive operations, eventually terminating
any running \f[C]pg_receivexlog\f[] for the server.
Global/Server.
.RS
.RE
.TP
.B streaming_archiver_batch_size
This option allows you to activate batch processing of WAL files for the
\f[C]streaming_archiver\f[] process, by setting it to a value > 0.
Otherwise, the traditional unlimited processing of the WAL queue is
enabled.
When batch processing is activated, the \f[C]archive\-wal\f[] process
would limit itself to maximum \f[C]streaming_archiver_batch_size\f[] WAL
segments per single run.
Integer.
Global/Server.
.RS
.RE
.TP
.B streaming_archiver_name
Identifier to be used as \f[C]application_name\f[] by the
\f[C]receive\-wal\f[] command.
Only available with \f[C]pg_receivewal\f[] (or \f[C]pg_receivexlog\f[]
>= 9.3).
By default it is set to \f[C]barman_receive_wal\f[].
Global/Server.
.RS
.RE
.TP
.B streaming_backup_name
Identifier to be used as \f[C]application_name\f[] by the
\f[C]pg_basebackup\f[] command.
Only available with \f[C]pg_basebackup\f[] >= 9.3.
By default it is set to \f[C]barman_streaming_backup\f[].
Global/Server.
.RS
.RE
.TP
.B streaming_conninfo
Connection string used by Barman to connect to the Postgres server via
streaming replication protocol.
By default it is set to \f[C]conninfo\f[].
Server.
.RS
.RE
.TP
.B streaming_wals_directory
Directory where WAL files are streamed from the PostgreSQL server to
Barman.
Requires \f[C]streaming_archiver\f[] to be enabled.
Server.
.RS
.RE
.TP
.B tablespace_bandwidth_limit
This option allows you to specify a maximum transfer rate in kilobytes
per second, by specifying a comma separated list of tablespaces (pairs
TBNAME:BWLIMIT).
A value of zero specifies no limit (default).
Global/Server.
.RS
.RE
.TP
.B wal_retention_policy
Policy for retention of archive logs (WAL files).
Currently only "MAIN" is available.
Global/Server.
.RS
.RE
.TP
.B wals_directory
Directory which contains WAL files.
Server.
.RS
.RE
.SH HOOK SCRIPTS
.PP
The script definition is passed to a shell and can return any exit code.
.PP
The shell environment will contain the following variables:
.TP
.B \f[C]BARMAN_CONFIGURATION\f[]
configuration file used by barman
.RS
.RE
.TP
.B \f[C]BARMAN_ERROR\f[]
error message, if any (only for the \[aq]post\[aq] phase)
.RS
.RE
.TP
.B \f[C]BARMAN_PHASE\f[]
\[aq]pre\[aq] or \[aq]post\[aq]
.RS
.RE
.TP
.B \f[C]BARMAN_RETRY\f[]
\f[C]1\f[] if it is a \f[I]retry script\f[] (from 1.5.0), \f[C]0\f[] if
not
.RS
.RE
.TP
.B \f[C]BARMAN_SERVER\f[]
name of the server
.RS
.RE
.PP
Backup scripts specific variables:
.TP
.B \f[C]BARMAN_BACKUP_DIR\f[]
backup destination directory
.RS
.RE
.TP
.B \f[C]BARMAN_BACKUP_ID\f[]
ID of the backup
.RS
.RE
.TP
.B \f[C]BARMAN_PREVIOUS_ID\f[]
ID of the previous backup (if present)
.RS
.RE
.TP
.B \f[C]BARMAN_NEXT_ID\f[]
ID of the next backup (if present)
.RS
.RE
.TP
.B \f[C]BARMAN_STATUS\f[]
status of the backup
.RS
.RE
.TP
.B \f[C]BARMAN_VERSION\f[]
version of Barman
.RS
.RE
.PP
Archive scripts specific variables:
.TP
.B \f[C]BARMAN_SEGMENT\f[]
name of the WAL file
.RS
.RE
.TP
.B \f[C]BARMAN_FILE\f[]
full path of the WAL file
.RS
.RE
.TP
.B \f[C]BARMAN_SIZE\f[]
size of the WAL file
.RS
.RE
.TP
.B \f[C]BARMAN_TIMESTAMP\f[]
WAL file timestamp
.RS
.RE
.TP
.B \f[C]BARMAN_COMPRESSION\f[]
type of compression used for the WAL file
.RS
.RE
.PP
Recovery scripts specific variables:
.TP
.B \f[C]BARMAN_DESTINATION_DIRECTORY\f[]
the directory where the new instance is recovered
.RS
.RE
.TP
.B \f[C]BARMAN_TABLESPACES\f[]
tablespace relocation map (JSON, if present)
.RS
.RE
.TP
.B \f[C]BARMAN_REMOTE_COMMAND\f[]
secure shell command used by the recovery (if present)
.RS
.RE
.TP
.B \f[C]BARMAN_RECOVER_OPTIONS\f[]
recovery additional options (JSON, if present)
.RS
.RE
.PP
Only in case of retry hook scripts, the exit code of the script is
checked by Barman.
Output of hook scripts is simply written in the log file.
.SH EXAMPLE
.PP
Here is an example of configuration file:
.IP
.nf
\f[C]
[barman]
;\ Main\ directory
barman_home\ =\ /var/lib/barman
;\ System\ user
barman_user\ =\ barman
;\ Log\ location
log_file\ =\ /var/log/barman/barman.log
;\ Default\ compression\ level
;compression\ =\ gzip
;\ Incremental\ backup
reuse_backup\ =\ link
;\ \[aq]main\[aq]\ PostgreSQL\ Server\ configuration
[main]
;\ Human\ readable\ description
description\ =\ \ "Main\ PostgreSQL\ Database"
;\ SSH\ options
ssh_command\ =\ ssh\ postgres\@pg
;\ PostgreSQL\ connection\ string
conninfo\ =\ host=pg\ user=postgres
;\ PostgreSQL\ streaming\ connection\ string
streaming_conninfo\ =\ host=pg\ user=postgres
;\ Minimum\ number\ of\ required\ backups\ (redundancy)
minimum_redundancy\ =\ 1
;\ Retention\ policy\ (based\ on\ redundancy)
retention_policy\ =\ REDUNDANCY\ 2
\f[]
.fi
.SH SEE ALSO
.PP
\f[C]barman\f[] (1).
.SH AUTHORS
.PP
Barman maintainers (in alphabetical order):
.IP \[bu] 2
Abhijit Menon\-Sen
.IP \[bu] 2
Jane Threefoot
.IP \[bu] 2
Michael Wallace
.PP
Past contributors (in alphabetical order):
.IP \[bu] 2
Anna Bellandi (QA/testing)
.IP \[bu] 2
Britt Cole (documentation reviewer)
.IP \[bu] 2
Carlo Ascani (developer)
.IP \[bu] 2
Francesco Canovai (QA/testing)
.IP \[bu] 2
Gabriele Bartolini (architect)
.IP \[bu] 2
Gianni Ciolli (QA/testing)
.IP \[bu] 2
Giulio Calacoci (developer)
.IP \[bu] 2
Giuseppe Broccolo (developer)
.IP \[bu] 2
Jonathan Battiato (QA/testing)
.IP \[bu] 2
Leonardo Cecchi (developer)
.IP \[bu] 2
Marco Nenciarini (project leader)
.IP \[bu] 2
Niccolò Fei (QA/testing)
.IP \[bu] 2
Rubens Souza (QA/testing)
.IP \[bu] 2
Stefano Bianucci (developer)
.SH RESOURCES
.IP \[bu] 2
Homepage:
.IP \[bu] 2
Documentation:
.IP \[bu] 2
Professional support:
.SH COPYING
.PP
Barman is the property of EnterpriseDB UK Limited and its code is
distributed under GNU General Public License v3.
.PP
© Copyright EnterpriseDB UK Limited 2011\-2022
.SH AUTHORS
EnterpriseDB .
barman-2.18/doc/barman-cloud-wal-archive.1 0000644 0006212 0006212 00000015173 14172556763 016502 0 ustar 0000000 0000000 .\" Automatically generated by Pandoc 2.2.1
.\"
.TH "BARMAN\-CLOUD\-WAL\-ARCHIVE" "1" "January 21, 2022" "Barman User manuals" "Version 2.18"
.hy
.SH NAME
.PP
barman\-cloud\-wal\-archive \- Archive PostgreSQL WAL files in the Cloud
using \f[C]archive_command\f[]
.SH SYNOPSIS
.PP
barman\-cloud\-wal\-archive [\f[I]OPTIONS\f[]] \f[I]DESTINATION_URL\f[]
\f[I]SERVER_NAME\f[] \f[I]WAL_PATH\f[]
.SH DESCRIPTION
.PP
This script can be used in the \f[C]archive_command\f[] of a PostgreSQL
server to ship WAL files to the Cloud.
Currently AWS S3 and Azure Blob Storage are supported.
.PP
Note: If you are running python 2 or older unsupported versions of
python 3 then avoid the compression options \f[C]\-\-gzip\f[] or
\f[C]\-\-bzip2\f[] as barman\-cloud\-wal\-restore is unable to restore
gzip\-compressed WALs on python < 3.2 or bzip2\-compressed WALs on
python < 3.3.
.PP
This script and Barman are administration tools for disaster recovery of
PostgreSQL servers written in Python and maintained by EnterpriseDB.
.SH POSITIONAL ARGUMENTS
.TP
.B DESTINATION_URL
URL of the cloud destination, such as a bucket in AWS S3.
For example: \f[C]s3://BUCKET_NAME/path/to/folder\f[] (where
\f[C]BUCKET_NAME\f[] is the bucket you have created in AWS).
.RS
.RE
.TP
.B SERVER_NAME
the name of the server as configured in Barman.
.RS
.RE
.TP
.B WAL_PATH
the value of the `%p' keyword (according to `archive_command').
.RS
.RE
.SH OPTIONS
.TP
.B \-h, \[en]help
show a help message and exit
.RS
.RE
.TP
.B \-V, \[en]version
show program's version number and exit
.RS
.RE
.TP
.B \-v, \[en]verbose
increase output verbosity (e.g., \-vv is more than \-v)
.RS
.RE
.TP
.B \-q, \[en]quiet
decrease output verbosity (e.g., \-qq is less than \-q)
.RS
.RE
.TP
.B \-t, \[en]test
test connectivity to the cloud destination and exit
.RS
.RE
.TP
.B \-z, \[en]gzip
gzip\-compress the WAL while uploading to the cloud (should not be used
with python < 3.2)
.RS
.RE
.TP
.B \-j, \[en]bzip2
bzip2\-compress the WAL while uploading to the cloud (should not be used
with python < 3.3)
.RS
.RE
.TP
.B \[en]snappy
snappy\-compress the WAL while uploading to the cloud (requires optional
python\-snappy library and should not be used with python < 3.3)
.RS
.RE
.TP
.B \[en]cloud\-provider {aws\-s3,azure\-blob\-storage}
the cloud provider to which the backup should be uploaded
.RS
.RE
.TP
.B \[en]tags KEY1,VALUE1 KEY2,VALUE2 \&...
A space\-separated list of comma\-separated key\-value pairs
representing tags to be added to each WAL file archived to cloud
storage.
.RS
.RE
.TP
.B \[en]history\-tags KEY1,VALUE1 KEY2,VALUE2 \&...
A space\-separated list of comma\-separated key\-value pairs
representing tags to be added to each history file archived to cloud
storage.
If this is provided alongside the \f[C]\-\-tags\f[] option then the
value of \f[C]\-\-history\-tags\f[] will be used in place of
\f[C]\-\-tags\f[] for history files.
All other WAL files will continue to be tagged with the value of
\f[C]\-\-tags\f[].
.RS
.RE
.TP
.B \-P, \[en]profile
profile name (e.g.\ INI section in AWS credentials file)
.RS
.RE
.TP
.B \[en]endpoint\-url
override the default S3 URL construction mechanism by specifying an
endpoint.
.RS
.RE
.TP
.B \-e, \[en]encryption
the encryption algorithm used when storing the uploaded data in S3
Allowed values: `AES256'|`aws:kms'
.RS
.RE
.TP
.B \[en]encryption\-scope
the name of an encryption scope defined in the Azure Blob Storage
service which is to be used to encrypt the data in Azure
.RS
.RE
.TP
.B \[en]credential {azure\-cli,managed\-identity}
optionally specify the type of credential to use when authenticating
with Azure Blob Storage.
If omitted then the credential will be obtained from the environment.
If no credentials can be found in the environment then the default Azure
authentication flow will be used.
.RS
.RE
.TP
.B \[en]max\-block\-size SIZE
the chunk size to be used when uploading an object to Azure Blob Storage
via the concurrent chunk method (default: 4MB).
.RS
.RE
.TP
.B \[en]max\-concurrency CONCURRENCY
the maximum number of chunks to be uploaded concurrently to Azure Blob
Storage (default: 1).
Whether the maximum concurrency is achieved depends on the values of
\[en]max\-block\-size (should be less than or equal to
\f[C]WAL\ segment\ size\ after\ compression\ /\ max_concurrency\f[]) and
\[en]max\-single\-put\-size (must be less than WAL segment size after
compression).
.RS
.RE
.TP
.B \[en]max\-single\-put\-size SIZE
maximum size for which the Azure client will upload an object to Azure
Blob Storage in a single request (default: 64MB).
If this is set lower than the WAL segment size after any applied
compression then the concurrent chunk upload method for WAL archiving
will be used.
.RS
.RE
.SH REFERENCES
.PP
For Boto:
.IP \[bu] 2
https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html
.PP
For AWS:
.IP \[bu] 2
http://docs.aws.amazon.com/cli/latest/userguide/cli\-chap\-getting\-set\-up.html
.IP \[bu] 2
http://docs.aws.amazon.com/cli/latest/userguide/cli\-chap\-getting\-started.html.
.PP
For Azure Blob Storage:
.IP \[bu] 2
https://docs.microsoft.com/en\-us/azure/storage/blobs/authorize\-data\-operations\-cli#set\-environment\-variables\-for\-authorization\-parameters
.IP \[bu] 2
https://docs.microsoft.com/en\-us/python/api/azure\-storage\-blob/?view=azure\-python
.SH DEPENDENCIES
.PP
If using \f[C]\-\-cloud\-provider=aws\-s3\f[]:
.IP \[bu] 2
boto3
.PP
If using \f[C]\-\-cloud\-provider=azure\-blob\-storage\f[]:
.IP \[bu] 2
azure\-storage\-blob
.IP \[bu] 2
azure\-identity (optional, if you wish to use DefaultAzureCredential)
.SH EXIT STATUS
.TP
.B 0
Success
.RS
.RE
.TP
.B 1
The WAL archive operation was not successful
.RS
.RE
.TP
.B 2
The connection to the cloud provider failed
.RS
.RE
.TP
.B 3
There was an error in the command input
.RS
.RE
.TP
.B Other non\-zero codes
Failure
.RS
.RE
.SH SEE ALSO
.PP
This script can be used in conjunction with
\f[C]pre_archive_retry_script\f[] to relay WAL files to S3, as follows:
.IP
.nf
\f[C]
pre_archive_retry_script\ =\ \[aq]barman\-cloud\-wal\-archive\ [*OPTIONS*]\ *DESTINATION_URL*\ ${BARMAN_SERVER}\[aq]
\f[]
.fi
.SH BUGS
.PP
Barman has been extensively tested, and is currently being used in
several production environments.
However, we cannot exclude the presence of bugs.
.PP
Any bug can be reported via the Github issue tracker.
.SH RESOURCES
.IP \[bu] 2
Homepage:
.IP \[bu] 2
Documentation:
.IP \[bu] 2
Professional support:
.SH COPYING
.PP
Barman is the property of EnterpriseDB UK Limited and its code is
distributed under GNU General Public License v3.
.PP
© Copyright EnterpriseDB UK Limited 2011\-2022
.SH AUTHORS
EnterpriseDB .
barman-2.18/doc/barman.1 0000644 0006212 0006212 00000054731 14172556763 013201 0 ustar 0000000 0000000 .\" Automatically generated by Pandoc 2.2.1
.\"
.TH "BARMAN" "1" "January 21, 2022" "Barman User manuals" "Version 2.18"
.hy
.SH NAME
.PP
barman \- Backup and Recovery Manager for PostgreSQL
.SH SYNOPSIS
.PP
barman [\f[I]OPTIONS\f[]] \f[I]COMMAND\f[]
.SH DESCRIPTION
.PP
Barman is an administration tool for disaster recovery of PostgreSQL
servers written in Python and maintained by EnterpriseDB.
Barman can perform remote backups of multiple servers in business
critical environments and helps DBAs during the recovery phase.
.SH OPTIONS
.TP
.B \-h, \-\-help
Show a help message and exit.
.RS
.RE
.TP
.B \-v, \-\-version
Show program version number and exit.
.RS
.RE
.TP
.B \-c \f[I]CONFIG\f[], \-\-config \f[I]CONFIG\f[]
Use the specified configuration file.
.RS
.RE
.TP
.B \-\-color \f[I]{never,always,auto}\f[], \-\-colour \f[I]{never,always,auto}\f[]
Whether to use colors in the output (default: \f[I]auto\f[])
.RS
.RE
.TP
.B \-q, \-\-quiet
Do not output anything.
Useful for cron scripts.
.RS
.RE
.TP
.B \-d, \-\-debug
debug output (default: False)
.RS
.RE
.TP
.B \-\-log\-level {NOTSET,DEBUG,INFO,WARNING,ERROR,CRITICAL}
Override the default log level
.RS
.RE
.TP
.B \-f {json,console}, \-\-format {json,console}
output format (default: \[aq]console\[aq])
.RS
.RE
.SH COMMANDS
.PP
Important: every command has a help option
.TP
.B archive\-wal \f[I]SERVER_NAME\f[]
Get any incoming xlog file (both through standard
\f[C]archive_command\f[] and streaming replication, where applicable)
and moves them in the WAL archive for that server.
If necessary, apply compression when requested by the user.
.RS
.RE
.TP
.B backup \f[I]SERVER_NAME\f[]
Perform a backup of \f[C]SERVER_NAME\f[] using parameters specified in
the configuration file.
Specify \f[C]all\f[] as \f[C]SERVER_NAME\f[] to perform a backup of all
the configured servers.
.RS
.TP
.B \-\-immediate\-checkpoint
forces the initial checkpoint to be done as quickly as possible.
Overrides value of the parameter \f[C]immediate_checkpoint\f[], if
present in the configuration file.
.RS
.RE
.TP
.B \-\-no\-immediate\-checkpoint
forces to wait for the checkpoint.
Overrides value of the parameter \f[C]immediate_checkpoint\f[], if
present in the configuration file.
.RS
.RE
.TP
.B \-\-reuse\-backup [INCREMENTAL_TYPE]
Overrides \f[C]reuse_backup\f[] option behaviour.
Possible values for \f[C]INCREMENTAL_TYPE\f[] are:
.RS
.IP \[bu] 2
\f[I]off\f[]: do not reuse the last available backup;
.IP \[bu] 2
\f[I]copy\f[]: reuse the last available backup for a server and create a
copy of the unchanged files (reduce backup time);
.IP \[bu] 2
\f[I]link\f[]: reuse the last available backup for a server and create a
hard link of the unchanged files (reduce backup time and space);
.PP
\f[C]link\f[] is the default target if \f[C]\-\-reuse\-backup\f[] is
used and \f[C]INCREMENTAL_TYPE\f[] is not explicit.
.RE
.TP
.B \-\-retry\-times
Number of retries of base backup copy, after an error.
Used during both backup and recovery operations.
Overrides value of the parameter \f[C]basebackup_retry_times\f[], if
present in the configuration file.
.RS
.RE
.TP
.B \-\-no\-retry
Same as \f[C]\-\-retry\-times\ 0\f[]
.RS
.RE
.TP
.B \-\-retry\-sleep
Number of seconds of wait after a failed copy, before retrying.
Used during both backup and recovery operations.
Overrides value of the parameter \f[C]basebackup_retry_sleep\f[], if
present in the configuration file.
.RS
.RE
.TP
.B \-j, \-\-jobs
Number of parallel workers to copy files during backup.
Overrides value of the parameter \f[C]parallel_jobs\f[], if present in
the configuration file.
.RS
.RE
.TP
.B \-\-bwlimit KBPS
maximum transfer rate in kilobytes per second.
A value of 0 means no limit.
Overrides \[aq]bandwidth_limit\[aq] configuration option.
Default is undefined.
.RS
.RE
.TP
.B \-\-wait, \-w
wait for all required WAL files by the base backup to be archived
.RS
.RE
.TP
.B \-\-wait\-timeout
the time, in seconds, spent waiting for the required WAL files to be
archived before timing out
.RS
.RE
.RE
.TP
.B check\-backup \f[I]SERVER_NAME\f[] \f[I]BACKUP_ID\f[]
Make sure that all the required WAL files to check the consistency of a
physical backup (that is, from the beginning to the end of the full
backup) are correctly archived.
This command is automatically invoked by the \f[C]cron\f[] command and
at the end of every backup operation.
.RS
.RE
.TP
.B check\-wal\-archive \f[I]SERVER_NAME\f[]
Check that the WAL archive destination for \f[I]SERVER_NAME\f[] is safe
to use for a new PostgreSQL cluster.
With no optional args (the default) this will pass if the WAL archive is
empty and fail otherwise.
.RS
.TP
.B \-\-timeline [TIMELINE]
A positive integer specifying the earliest timeline for which associated
WALs should cause the check to fail.
The check will pass if all WAL content in the archive relates to earlier
timelines.
If any WAL files are on this timeline or greater then the check will
fail.
.RS
.RE
.RE
.TP
.B check \f[I]SERVER_NAME\f[]
Show diagnostic information about \f[C]SERVER_NAME\f[], including: Ssh
connection check, PostgreSQL version, configuration and backup
directories, archiving process, streaming process, replication slots,
etc.
Specify \f[C]all\f[] as \f[C]SERVER_NAME\f[] to show diagnostic
information about all the configured servers.
.RS
.TP
.B \-\-nagios
Nagios plugin compatible output
.RS
.RE
.RE
.TP
.B cron
Perform maintenance tasks, such as enforcing retention policies or WAL
files management.
.RS
.TP
.B \-\-keep\-descriptors
Keep the stdout and the stderr streams of the Barman subprocesses
attached to this one.
This is useful for Docker based installations.
.RS
.RE
.RE
.TP
.B delete \f[I]SERVER_NAME\f[] \f[I]BACKUP_ID\f[]
Delete the specified backup.
Backup ID shortcuts section below for available shortcuts.
.RS
.RE
.TP
.B diagnose
Collect diagnostic information about the server where barman is
installed and all the configured servers, including: global
configuration, SSH version, Python version, \f[C]rsync\f[] version, as
well as current configuration and status of all servers.
.RS
.RE
.TP
.B get\-wal \f[I][OPTIONS]\f[] \f[I]SERVER_NAME\f[] \f[I]WAL_NAME\f[]
Retrieve a WAL file from the \f[C]xlog\f[] archive of a given server.
By default, the requested WAL file, if found, is returned as
uncompressed content to \f[C]STDOUT\f[].
The following options allow users to change this behaviour:
.RS
.TP
.B \-o \f[I]OUTPUT_DIRECTORY\f[]
destination directory where the \f[C]get\-wal\f[] will deposit the
requested WAL
.RS
.RE
.TP
.B \-P, \-\-partial
retrieve also partial WAL files (.partial)
.RS
.RE
.TP
.B \-z
output will be compressed using gzip
.RS
.RE
.TP
.B \-j
output will be compressed using bzip2
.RS
.RE
.TP
.B \-p \f[I]SIZE\f[]
peek from the WAL archive up to \f[I]SIZE\f[] WAL files, starting from
the requested one.
\[aq]SIZE\[aq] must be an integer >= 1.
When invoked with this option, get\-wal returns a list of zero to
\[aq]SIZE\[aq] WAL segment names, one per row.
.RS
.RE
.TP
.B \-t, \-\-test
test both the connection and the configuration of the requested
PostgreSQL server in Barman for WAL retrieval.
With this option, the \[aq]WAL_NAME\[aq] mandatory argument is ignored.
.RS
.RE
.RE
.TP
.B keep \f[I]SERVER_NAME\f[] \f[I]BACKUP_ID\f[]
Flag the specified backup as an archival backup which should be kept
forever, regardless of any retention policies in effect.
See the Backup ID shortcuts section below for available shortcuts.
.RS
.TP
.B \-\-target \f[I]RECOVERY_TARGET\f[]
Specify the recovery target for the archival backup.
Possible values for \f[I]RECOVERY_TARGET\f[] are:
.RS
.IP \[bu] 2
\f[I]full\f[]: The backup can always be used to recover to the latest
point in time.
To achieve this, Barman will retain all WALs needed to ensure
consistency of the backup and all subsequent WALs.
.IP \[bu] 2
\f[I]standalone\f[]: The backup can only be used to recover the server
to its state at the time the backup was taken.
Barman will only retain the WALs needed to ensure consistency of the
backup.
.RE
.TP
.B \-\-status
Report the archival status of the backup.
This will either be the recovery target of \f[I]full\f[] or
\f[I]standalone\f[] for archival backups or \f[I]nokeep\f[] for backups
which have not been flagged as archival.
.RS
.RE
.TP
.B \-\-release
Release the keep flag from this backup.
This will remove its archival status and make it available for deletion,
either directly or by retention policy.
.RS
.RE
.RE
.TP
.B list\-backups \f[I]SERVER_NAME\f[]
Show available backups for \f[C]SERVER_NAME\f[].
This command is useful to retrieve a backup ID.
For example:
.RS
.RE
.IP
.nf
\f[C]
servername\ 20111104T102647\ \-\ Fri\ Nov\ \ 4\ 10:26:48\ 2011\ \-\ Size:\ 17.0\ MiB\ \-\ WAL\ Size:\ 100\ B
\f[]
.fi
.IP
.nf
\f[C]
In\ this\ case,\ *20111104T102647*\ is\ the\ backup\ ID.
\f[]
.fi
.TP
.B list\-files \f[I][OPTIONS]\f[] \f[I]SERVER_NAME\f[] \f[I]BACKUP_ID\f[]
List all the files in a particular backup, identified by the server name
and the backup ID.
See the Backup ID shortcuts section below for available shortcuts.
.RS
.TP
.B \-\-target \f[I]TARGET_TYPE\f[]
Possible values for TARGET_TYPE are:
.RS
.IP \[bu] 2
\f[I]data\f[]: lists just the data files;
.IP \[bu] 2
\f[I]standalone\f[]: lists the base backup files, including required WAL
files;
.IP \[bu] 2
\f[I]wal\f[]: lists all the WAL files between the start of the base
backup and the end of the log / the start of the following base backup
(depending on whether the specified base backup is the most recent one
available);
.IP \[bu] 2
\f[I]full\f[]: same as data + wal.
.PP
The default value is \f[C]standalone\f[].
.RE
.RE
.TP
.B list\-servers
Show all the configured servers, and their descriptions.
.RS
.RE
.TP
.B put\-wal \f[I][OPTIONS]\f[] \f[I]SERVER_NAME\f[]
Receive a WAL file from a remote server and securely store it into the
\f[C]SERVER_NAME\f[] incoming directory.
The WAL file is retrieved from the \f[C]STDIN\f[], and must be
encapsulated in a tar stream together with a \f[C]MD5SUMS\f[] file to
validate it.
This command is meant to be invoked through SSH from a remote
\f[C]barman\-wal\-archive\f[] utility (part of \f[C]barman\-cli\f[]
package).
Do not use this command directly unless you take full responsibility of
the content of files.
.RS
.TP
.B \-t, \-\-test
test both the connection and the configuration of the requested
PostgreSQL server in Barman to make sure it is ready to receive WAL
files.
.RS
.RE
.RE
.TP
.B rebuild\-xlogdb \f[I]SERVER_NAME\f[]
Perform a rebuild of the WAL file metadata for \f[C]SERVER_NAME\f[] (or
every server, using the \f[C]all\f[] shortcut) guessing it from the disk
content.
The metadata of the WAL archive is contained in the \f[C]xlog.db\f[]
file, and every Barman server has its own copy.
.RS
.RE
.TP
.B receive\-wal \f[I]SERVER_NAME\f[]
Start the stream of transaction logs for a server.
The process relies on \f[C]pg_receivewal\f[]/\f[C]pg_receivexlog\f[] to
receive WAL files from the PostgreSQL servers through the streaming
protocol.
.RS
.TP
.B \-\-stop
stop the receive\-wal process for the server
.RS
.RE
.TP
.B \-\-reset
reset the status of receive\-wal, restarting the streaming from the
current WAL file of the server
.RS
.RE
.TP
.B \-\-create\-slot
create the physical replication slot configured with the
\f[C]slot_name\f[] configuration parameter
.RS
.RE
.TP
.B \-\-drop\-slot
drop the physical replication slot configured with the
\f[C]slot_name\f[] configuration parameter
.RS
.RE
.RE
.TP
.B recover \f[I][OPTIONS]\f[] \f[I]SERVER_NAME\f[] \f[I]BACKUP_ID\f[] \f[I]DESTINATION_DIRECTORY\f[]
Recover a backup in a given directory (local or remote, depending on the
\f[C]\-\-remote\-ssh\-command\f[] option settings).
See the Backup ID shortcuts section below for available shortcuts.
.RS
.TP
.B \-\-target\-tli \f[I]TARGET_TLI\f[]
Recover the specified timeline.
.RS
.RE
.TP
.B \-\-target\-time \f[I]TARGET_TIME\f[]
Recover to the specified time.
.RS
.PP
You can use any valid unambiguous representation (e.g: "YYYY\-MM\-DD
HH:MM:SS.mmm").
.RE
.TP
.B \-\-target\-xid \f[I]TARGET_XID\f[]
Recover to the specified transaction ID.
.RS
.RE
.TP
.B \-\-target\-lsn \f[I]TARGET_LSN\f[]
Recover to the specified LSN (Log Sequence Number).
Requires PostgreSQL 10 or above.
.RS
.RE
.TP
.B \-\-target\-name \f[I]TARGET_NAME\f[]
Recover to the named restore point previously created with the
\f[C]pg_create_restore_point(name)\f[] (for PostgreSQL 9.1 and above
users).
.RS
.RE
.TP
.B \-\-target\-immediate
Recover ends when a consistent state is reached (end of the base backup)
.RS
.RE
.TP
.B \-\-exclusive
Set target (time, XID or LSN) to be non inclusive.
.RS
.RE
.TP
.B \-\-target\-action \f[I]ACTION\f[]
Trigger the specified action once the recovery target is reached.
Possible actions are: \f[C]pause\f[] (PostgreSQL 9.1 and above),
\f[C]shutdown\f[] (PostgreSQL 9.5 and above) and \f[C]promote\f[]
(ditto).
This option requires a target to be defined, with one of the above
options.
.RS
.RE
.TP
.B \-\-tablespace \f[I]NAME:LOCATION\f[]
Specify tablespace relocation rule.
.RS
.RE
.TP
.B \-\-remote\-ssh\-command \f[I]SSH_COMMAND\f[]
This options activates remote recovery, by specifying the secure shell
command to be launched on a remote host.
This is the equivalent of the "ssh_command" server option in the
configuration file for remote recovery.
Example: \[aq]ssh postgres\@db2\[aq].
.RS
.RE
.TP
.B \-\-retry\-times \f[I]RETRY_TIMES\f[]
Number of retries of data copy during base backup after an error.
Overrides value of the parameter \f[C]basebackup_retry_times\f[], if
present in the configuration file.
.RS
.RE
.TP
.B \-\-no\-retry
Same as \f[C]\-\-retry\-times\ 0\f[]
.RS
.RE
.TP
.B \-\-retry\-sleep
Number of seconds of wait after a failed copy, before retrying.
Overrides value of the parameter \f[C]basebackup_retry_sleep\f[], if
present in the configuration file.
.RS
.RE
.TP
.B \-\-bwlimit KBPS
maximum transfer rate in kilobytes per second.
A value of 0 means no limit.
Overrides \[aq]bandwidth_limit\[aq] configuration option.
Default is undefined.
.RS
.RE
.TP
.B \-j , \-\-jobs
Number of parallel workers to copy files during recovery.
Overrides value of the parameter \f[C]parallel_jobs\f[], if present in
the configuration file.
Works only for servers configured through \f[C]rsync\f[]/SSH.
.RS
.RE
.TP
.B \-\-get\-wal, \-\-no\-get\-wal
Enable/Disable usage of \f[C]get\-wal\f[] for WAL fetching during
recovery.
Default is based on \f[C]recovery_options\f[] setting.
.RS
.RE
.TP
.B \-\-network\-compression, \-\-no\-network\-compression
Enable/Disable network compression during remote recovery.
Default is based on \f[C]network_compression\f[] configuration setting.
.RS
.RE
.TP
.B \-\-standby\-mode
Specifies whether to start the PostgreSQL server as a standby.
Default is undefined.
.RS
.RE
.RE
.TP
.B replication\-status \f[I][OPTIONS]\f[] \f[I]SERVER_NAME\f[]
Shows live information and status of any streaming client attached to
the given server (or servers).
Default behaviour can be changed through the following options:
.RS
.TP
.B \-\-minimal
machine readable output (default: False)
.RS
.RE
.TP
.B \-\-target \f[I]TARGET_TYPE\f[]
Possible values for TARGET_TYPE are:
.RS
.IP \[bu] 2
\f[I]hot\-standby\f[]: lists only hot standby servers
.IP \[bu] 2
\f[I]wal\-streamer\f[]: lists only WAL streaming clients, such as
pg_receivewal
.IP \[bu] 2
\f[I]all\f[]: any streaming client (default)
.RE
.RE
.TP
.B show\-backup \f[I]SERVER_NAME\f[] \f[I]BACKUP_ID\f[]
Show detailed information about a particular backup, identified by the
server name and the backup ID.
See the Backup ID shortcuts section below for available shortcuts.
For example:
.RS
.RE
.IP
.nf
\f[C]
Backup\ 20150828T130001:
\ \ Server\ Name\ \ \ \ \ \ \ \ \ \ \ \ :\ quagmire
\ \ Status\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ :\ DONE
\ \ PostgreSQL\ Version\ \ \ \ \ :\ 90402
\ \ PGDATA\ directory\ \ \ \ \ \ \ :\ /srv/postgresql/9.4/main/data
\ \ Base\ backup\ information:
\ \ \ \ Disk\ usage\ \ \ \ \ \ \ \ \ \ \ :\ 12.4\ TiB\ (12.4\ TiB\ with\ WALs)
\ \ \ \ Incremental\ size\ \ \ \ \ :\ 4.9\ TiB\ (\-60.02%)
\ \ \ \ Timeline\ \ \ \ \ \ \ \ \ \ \ \ \ :\ 1
\ \ \ \ Begin\ WAL\ \ \ \ \ \ \ \ \ \ \ \ :\ 0000000100000CFD000000AD
\ \ \ \ End\ WAL\ \ \ \ \ \ \ \ \ \ \ \ \ \ :\ 0000000100000D0D00000008
\ \ \ \ WAL\ number\ \ \ \ \ \ \ \ \ \ \ :\ 3932
\ \ \ \ WAL\ compression\ ratio:\ 79.51%
\ \ \ \ Begin\ time\ \ \ \ \ \ \ \ \ \ \ :\ 2015\-08\-28\ 13:00:01.633925+00:00
\ \ \ \ End\ time\ \ \ \ \ \ \ \ \ \ \ \ \ :\ 2015\-08\-29\ 10:27:06.522846+00:00
\ \ \ \ Begin\ Offset\ \ \ \ \ \ \ \ \ :\ 1575048
\ \ \ \ End\ Offset\ \ \ \ \ \ \ \ \ \ \ :\ 13853016
\ \ \ \ Begin\ XLOG\ \ \ \ \ \ \ \ \ \ \ :\ CFD/AD180888
\ \ \ \ End\ XLOG\ \ \ \ \ \ \ \ \ \ \ \ \ :\ D0D/8D36158
\ \ WAL\ information:
\ \ \ \ No\ of\ files\ \ \ \ \ \ \ \ \ \ :\ 35039
\ \ \ \ Disk\ usage\ \ \ \ \ \ \ \ \ \ \ :\ 121.5\ GiB
\ \ \ \ WAL\ rate\ \ \ \ \ \ \ \ \ \ \ \ \ :\ 275.50/hour
\ \ \ \ Compression\ ratio\ \ \ \ :\ 77.81%
\ \ \ \ Last\ available\ \ \ \ \ \ \ :\ 0000000100000D95000000E7
\ \ Catalog\ information:
\ \ \ \ Retention\ Policy\ \ \ \ \ :\ not\ enforced
\ \ \ \ Previous\ Backup\ \ \ \ \ \ :\ 20150821T130001
\ \ \ \ Next\ Backup\ \ \ \ \ \ \ \ \ \ :\ \-\ (this\ is\ the\ latest\ base\ backup)
\f[]
.fi
.TP
.B show\-servers \f[I]SERVER_NAME\f[]
Show information about \f[C]SERVER_NAME\f[], including:
\f[C]conninfo\f[], \f[C]backup_directory\f[], \f[C]wals_directory\f[]
and many more.
Specify \f[C]all\f[] as \f[C]SERVER_NAME\f[] to show information about
all the configured servers.
.RS
.RE
.TP
.B status \f[I]SERVER_NAME\f[]
Show information about the status of a server, including: number of
available backups, \f[C]archive_command\f[], \f[C]archive_status\f[] and
many more.
For example:
.RS
.RE
.IP
.nf
\f[C]
Server\ quagmire:
\ \ Description:\ The\ Giggity\ database
\ \ Passive\ node:\ False
\ \ PostgreSQL\ version:\ 9.3.9
\ \ pgespresso\ extension:\ Not\ available
\ \ PostgreSQL\ Data\ directory:\ /srv/postgresql/9.3/data
\ \ PostgreSQL\ \[aq]archive_command\[aq]\ setting:\ rsync\ \-a\ %p\ barman\@backup:/var/lib/barman/quagmire/incoming
\ \ Last\ archived\ WAL:\ 0000000100003103000000AD
\ \ Current\ WAL\ segment:\ 0000000100003103000000AE
\ \ Retention\ policies:\ enforced\ (mode:\ auto,\ retention:\ REDUNDANCY\ 2,\ WAL\ retention:\ MAIN)
\ \ No.\ of\ available\ backups:\ 2
\ \ First\ available\ backup:\ 20150908T003001
\ \ Last\ available\ backup:\ 20150909T003001
\ \ Minimum\ redundancy\ requirements:\ satisfied\ (2/1)
\f[]
.fi
.TP
.B switch\-wal \f[I]SERVER_NAME\f[]
Execute pg_switch_wal() on the target server (from PostgreSQL 10), or
pg_switch_xlog (for PostgreSQL 8.3 to 9.6).
.RS
.TP
.B \-\-force
Forces the switch by executing CHECKPOINT before pg_switch_xlog().
\f[I]IMPORTANT:\f[] executing a CHECKPOINT might increase I/O load on a
PostgreSQL server.
Use this option with care.
.RS
.RE
.TP
.B \-\-archive
Wait for one xlog file to be archived.
If after a defined amount of time (default: 30 seconds) no xlog file is
archived, Barman will terminate with failure exit code.
Available also on standby servers.
.RS
.RE
.TP
.B \-\-archive\-timeout \f[I]TIMEOUT\f[]
Specifies the amount of time in seconds (default: 30 seconds) the
archiver will wait for a new xlog file to be archived before timing out.
Available also on standby servers.
.RS
.RE
.RE
.TP
.B switch\-xlog \f[I]SERVER_NAME\f[]
Alias for switch\-wal (kept for back\-compatibility)
.RS
.RE
.TP
.B sync\-backup \f[I]SERVER_NAME\f[] \f[I]BACKUP_ID\f[]
Command used for the synchronisation of a passive node with its primary.
Executes a copy of all the files of a \f[C]BACKUP_ID\f[] that is present
on \f[C]SERVER_NAME\f[] node.
This command is available only for passive nodes, and uses the
\f[C]primary_ssh_command\f[] option to establish a secure connection
with the primary node.
.RS
.RE
.TP
.B sync\-info \f[I]SERVER_NAME\f[] [\f[I]LAST_WAL\f[] [\f[I]LAST_POSITION\f[]]]
Collect information regarding the current status of a Barman server, to
be used for synchronisation purposes.
Returns a JSON output representing \f[C]SERVER_NAME\f[], that contains:
all the successfully finished backup, all the archived WAL files, the
configuration, last WAL file been read from the \f[C]xlog.db\f[] and the
position in the file.
.RS
.TP
.B LAST_WAL
tells sync\-info to skip any WAL file previous to that (incremental
synchronisation)
.RS
.RE
.TP
.B LAST_POSITION
hint for quickly positioning in the \f[C]xlog.db\f[] file (incremental
synchronisation)
.RS
.RE
.RE
.TP
.B sync\-wals \f[I]SERVER_NAME\f[]
Command used for the synchronisation of a passive node with its primary.
Executes a copy of all the archived WAL files that are present on
\f[C]SERVER_NAME\f[] node.
This command is available only for passive nodes, and uses the
\f[C]primary_ssh_command\f[] option to establish a secure connection
with the primary node.
.RS
.RE
.SH BACKUP ID SHORTCUTS
.PP
Rather than using the timestamp backup ID, you can use any of the
following shortcuts/aliases to identity a backup for a given server:
.TP
.B first
Oldest available backup for that server, in chronological order.
.RS
.RE
.TP
.B last
Latest available backup for that server, in chronological order.
.RS
.RE
.TP
.B latest
same ast \f[I]last\f[].
.RS
.RE
.TP
.B oldest
same ast \f[I]first\f[].
.RS
.RE
.TP
.B last\-failed
Latest failed backup, in chronological order.
.RS
.RE
.SH EXIT STATUS
.TP
.B 0
Success
.RS
.RE
.TP
.B Not zero
Failure
.RS
.RE
.SH SEE ALSO
.PP
\f[C]barman\f[] (5).
.SH BUGS
.PP
Barman has been extensively tested, and is currently being used in
several production environments.
However, we cannot exclude the presence of bugs.
.PP
Any bug can be reported via the Github bug tracker.
Along with the bug submission, users can provide developers with
diagnostics information obtained through the \f[C]barman\ diagnose\f[]
command.
.SH AUTHORS
.PP
Barman maintainers (in alphabetical order):
.IP \[bu] 2
Abhijit Menon\-Sen
.IP \[bu] 2
Jane Threefoot
.IP \[bu] 2
Michael Wallace
.PP
Past contributors (in alphabetical order):
.IP \[bu] 2
Anna Bellandi (QA/testing)
.IP \[bu] 2
Britt Cole (documentation reviewer)
.IP \[bu] 2
Carlo Ascani (developer)
.IP \[bu] 2
Francesco Canovai (QA/testing)
.IP \[bu] 2
Gabriele Bartolini (architect)
.IP \[bu] 2
Gianni Ciolli (QA/testing)
.IP \[bu] 2
Giulio Calacoci (developer)
.IP \[bu] 2
Giuseppe Broccolo (developer)
.IP \[bu] 2
Jonathan Battiato (QA/testing)
.IP \[bu] 2
Leonardo Cecchi (developer)
.IP \[bu] 2
Marco Nenciarini (project leader)
.IP \[bu] 2
Niccolò Fei (QA/testing)
.IP \[bu] 2
Rubens Souza (QA/testing)
.IP \[bu] 2
Stefano Bianucci (developer)
.SH RESOURCES
.IP \[bu] 2
Homepage:
.IP \[bu] 2
Documentation:
.IP \[bu] 2
Professional support:
.SH COPYING
.PP
Barman is the property of EnterpriseDB UK Limited and its code is
distributed under GNU General Public License v3.
.PP
© Copyright EnterpriseDB UK Limited 2011\-2022
.SH AUTHORS
EnterpriseDB .
barman-2.18/doc/barman.5.d/ 0000755 0006212 0006212 00000000000 14172556766 013475 5 ustar 0000000 0000000 barman-2.18/doc/barman.5.d/50-custom_compression_filter.md 0000644 0006212 0006212 00000000144 14172556763 021535 0 ustar 0000000 0000000 custom_compression_filter
: Customised compression algorithm applied to WAL files. Global/Server.
barman-2.18/doc/barman.5.d/50-basebackups_directory.md 0000644 0006212 0006212 00000000117 14172556763 020604 0 ustar 0000000 0000000 basebackups_directory
: Directory where base backups will be placed. Server.
barman-2.18/doc/barman.5.d/50-basebackup_retry_times.md 0000644 0006212 0006212 00000000267 14172556763 020771 0 ustar 0000000 0000000 basebackup_retry_times
: Number of retries of base backup copy, after an error.
Used during both backup and recovery operations.
Positive integer, default 0. Global/Server.
barman-2.18/doc/barman.5.d/50-post_archive_retry_script.md 0000644 0006212 0006212 00000000604 14172556763 021535 0 ustar 0000000 0000000 post_archive_retry_script
: Hook script launched after a WAL file is archived by maintenance.
Being this a _retry_ hook script, Barman will retry the execution of the
script until this either returns a SUCCESS (0), an ABORT_CONTINUE (62) or
an ABORT_STOP (63) code. In a post archive scenario, ABORT_STOP
has currently the same effects as ABORT_CONTINUE. Global/Server.
barman-2.18/doc/barman.5.d/50-forward-config-path.md 0000644 0006212 0006212 00000000560 14172556763 020100 0 ustar 0000000 0000000 forward_config_path
: Parameter which determines whether a passive node should forward its
configuration file path to its primary node during cron or sync-info
commands. Set to true if you are invoking barman with the `-c/--config`
option and your configuration is in the same place on both the passive
and primary barman servers. Defaults to false.
barman-2.18/doc/barman.5.d/50-compression.md 0000644 0006212 0006212 00000000510 14172556763 016573 0 ustar 0000000 0000000 compression
: Standard compression algorithm applied to WAL files. Possible values
are: `gzip` (requires `gzip` to be installed on the system),
`bzip2` (requires `bzip2`), `pigz` (requires `pigz`), `pygzip`
(Python's internal gzip compressor) and `pybzip2` (Python's internal
bzip2 compressor). Global/Server.
barman-2.18/doc/barman.5.d/50-description.md 0000644 0006212 0006212 00000000102 14172556763 016552 0 ustar 0000000 0000000 description
: A human readable description of a server. Server.
barman-2.18/doc/barman.5.d/50-post_backup_script.md 0000644 0006212 0006212 00000000166 14172556763 020137 0 ustar 0000000 0000000 post_backup_script
: Hook script launched after a base backup, after 'post_backup_retry_script'.
Global/Server.
barman-2.18/doc/barman.5.d/50-log_level.md 0000644 0006212 0006212 00000000120 14172556763 016177 0 ustar 0000000 0000000 log_level
: Level of logging (DEBUG, INFO, WARNING, ERROR, CRITICAL). Global.
barman-2.18/doc/barman.5.d/50-backup_method.md 0000644 0006212 0006212 00000000764 14172556763 017052 0 ustar 0000000 0000000 backup_method
: Configure the method barman used for backup execution.
If set to `rsync` (default), barman will execute backup using the `rsync`
command over SSH (requires `ssh_command`).
If set to `postgres` barman will use the `pg_basebackup` command to execute the backup.
If set to `local-rsync`, barman will assume to be running on the same server
as the the PostgreSQL instance and with the same user, then execute `rsync` for the
file system copy.
Global/Server.
barman-2.18/doc/barman.5.d/50-streaming_archiver_batch_size.md 0000644 0006212 0006212 00000000671 14172556763 022311 0 ustar 0000000 0000000 streaming_archiver_batch_size
: This option allows you to activate batch processing of WAL files
for the `streaming_archiver` process, by setting it to a value > 0.
Otherwise, the traditional unlimited processing of the WAL queue
is enabled. When batch processing is activated, the `archive-wal`
process would limit itself to maximum `streaming_archiver_batch_size`
WAL segments per single run. Integer. Global/Server.
barman-2.18/doc/barman.5.d/50-pre_backup_retry_script.md 0000644 0006212 0006212 00000000623 14172556763 021163 0 ustar 0000000 0000000 pre_backup_retry_script
: Hook script launched before a base backup, after 'pre_backup_script'.
Being this a _retry_ hook script, Barman will retry the execution of the
script until this either returns a SUCCESS (0), an ABORT_CONTINUE (62) or
an ABORT_STOP (63) code. Returning ABORT_STOP will propagate the failure at
a higher level and interrupt the backup operation. Global/Server.
barman-2.18/doc/barman.5.d/50-primary_ssh_command.md 0000644 0006212 0006212 00000000547 14172556763 020302 0 ustar 0000000 0000000 primary_ssh_command
: Parameter that identifies a Barman server as `passive`.
In a passive node, the source of a backup server is a Barman installation
rather than a PostgreSQL server.
If `primary_ssh_command` is specified, Barman uses it to establish a
connection with the primary server.
Empty by default, it can also be set globally.
barman-2.18/doc/barman.5.d/50-recovery_options.md 0000644 0006212 0006212 00000000555 14172556763 017654 0 ustar 0000000 0000000 recovery_options
: Options for recovery operations. Currently only supports `get-wal`.
`get-wal` activates generation of a basic `restore_command` in
the resulting recovery configuration that uses the `barman get-wal`
command to fetch WAL files directly from Barman's archive of WALs.
Comma separated list of values, default empty. Global/Server.
barman-2.18/doc/barman.5.d/00-header.md 0000644 0006212 0006212 00000000160 14172556763 015456 0 ustar 0000000 0000000 % BARMAN(5) Barman User manuals | Version 2.18
% EnterpriseDB
% January 21, 2022
barman-2.18/doc/barman.5.d/50-incoming_wals_directory.md 0000644 0006212 0006212 00000000201 14172556763 021144 0 ustar 0000000 0000000 incoming_wals_directory
: Directory where incoming WAL files are archived into.
Requires `archiver` to be enabled. Server.
barman-2.18/doc/barman.5.d/50-conninfo.md 0000644 0006212 0006212 00000000556 14172556763 016055 0 ustar 0000000 0000000 conninfo
: Connection string used by Barman to connect to the Postgres server.
This is a libpq connection string, consult the
[PostgreSQL manual][conninfo] for more information. Commonly used
keys are: host, hostaddr, port, dbname, user, password. Server.
[conninfo]: https://www.postgresql.org/docs/current/static/libpq-connect.html#LIBPQ-CONNSTRING
barman-2.18/doc/barman.5.d/50-pre_wal_delete_retry_script.md 0000644 0006212 0006212 00000000651 14172556763 022024 0 ustar 0000000 0000000 pre_wal_delete_retry_script
: Hook script launched before the deletion of a WAL file, after 'pre_wal_delete_script'.
Being this a _retry_ hook script, Barman will retry the execution of the
script until this either returns a SUCCESS (0), an ABORT_CONTINUE (62) or
an ABORT_STOP (63) code. Returning ABORT_STOP will propagate the failure at
a higher level and interrupt the WAL file deletion. Global/Server.
barman-2.18/doc/barman.5.d/50-streaming_archiver.md 0000644 0006212 0006212 00000001213 14172556763 020107 0 ustar 0000000 0000000 streaming_archiver
: This option allows you to use the PostgreSQL's streaming protocol to
receive transaction logs from a server. If set to `on`, Barman expects
to find `pg_receivewal` (known as `pg_receivexlog` prior to
PostgreSQL 10) in the PATH (see `path_prefix` option) and that
streaming connection for the server is working. This activates connection
checks as well as management (including compression) of WAL files.
If set to `off` (default) barman will rely only on continuous archiving
for a server WAL archive operations, eventually terminating any running
`pg_receivexlog` for the server. Global/Server.
barman-2.18/doc/barman.5.d/50-post_recovery_retry_script.md 0000644 0006212 0006212 00000000553 14172556763 021755 0 ustar 0000000 0000000 post_recovery_retry_script
: Hook script launched after a recovery.
Being this a _retry_ hook script, Barman will retry the execution of the
script until this either returns a SUCCESS (0), an ABORT_CONTINUE (62) or
an ABORT_STOP (63) code. In a post recovery scenario, ABORT_STOP
has currently the same effects as ABORT_CONTINUE. Global/Server.
barman-2.18/doc/barman.5.d/20-configuration-file-locations.md 0000644 0006212 0006212 00000000322 14172556763 022005 0 ustar 0000000 0000000 # CONFIGURATION FILE LOCATIONS
The system-level Barman configuration file is located at
/etc/barman.conf
or
/etc/barman/barman.conf
and is overridden on a per-user level by
$HOME/.barman.conf
barman-2.18/doc/barman.5.d/50-wals_directory.md 0000644 0006212 0006212 00000000077 14172556763 017274 0 ustar 0000000 0000000 wals_directory
: Directory which contains WAL files. Server.
barman-2.18/doc/barman.5.d/50-pre_wal_delete_script.md 0000644 0006212 0006212 00000000141 14172556763 020571 0 ustar 0000000 0000000 pre_wal_delete_script
: Hook script launched before the deletion of a WAL file. Global/Server.
barman-2.18/doc/barman.5.d/50-post_archive_script.md 0000644 0006212 0006212 00000000220 14172556763 020302 0 ustar 0000000 0000000 post_archive_script
: Hook script launched after a WAL file is archived by maintenance,
after 'post_archive_retry_script'. Global/Server.
barman-2.18/doc/barman.5.d/50-pre_backup_script.md 0000644 0006212 0006212 00000000120 14172556763 017726 0 ustar 0000000 0000000 pre_backup_script
: Hook script launched before a base backup. Global/Server.
barman-2.18/doc/barman.5.d/50-retention_policy.md 0000644 0006212 0006212 00000001215 14172556763 017623 0 ustar 0000000 0000000 retention_policy
: Policy for retention of periodic backups and archive logs. If left empty,
retention policies are not enforced. For redundancy based retention policy
use "REDUNDANCY i" (where i is an integer > 0 and defines the number
of backups to retain). For recovery window retention policy use
"RECOVERY WINDOW OF i DAYS" or "RECOVERY WINDOW OF i WEEKS" or
"RECOVERY WINDOW OF i MONTHS" where i is a positive integer representing,
specifically, the number of days, weeks or months to retain your backups.
For more detailed information, refer to the official documentation.
Default value is empty. Global/Server.
barman-2.18/doc/barman.5.d/50-custom_decompression_filter.md 0000644 0006212 0006212 00000000242 14172556763 022045 0 ustar 0000000 0000000 custom_decompression_filter
: Customised decompression algorithm applied to compressed WAL files;
this must match the compression algorithm. Global/Server.
barman-2.18/doc/barman.5.d/50-wal_retention_policy.md 0000644 0006212 0006212 00000000202 14172556763 020461 0 ustar 0000000 0000000 wal_retention_policy
: Policy for retention of archive logs (WAL files). Currently only "MAIN"
is available. Global/Server.
barman-2.18/doc/barman.5.d/50-last_backup_maximum_age.md 0000644 0006212 0006212 00000000727 14172556763 021105 0 ustar 0000000 0000000 last_backup_maximum_age
: This option identifies a time frame that must contain the latest backup.
If the latest backup is older than the time frame, barman check command
will report an error to the user.
If empty (default), latest backup is always considered valid.
Syntax for this option is: "i (DAYS | WEEKS | MONTHS)" where i is a integer
greater than zero, representing the number of days | weeks | months
of the time frame. Global/Server.
barman-2.18/doc/barman.5.d/50-log_file.md 0000644 0006212 0006212 00000000064 14172556763 016016 0 ustar 0000000 0000000 log_file
: Location of Barman's log file. Global.
barman-2.18/doc/barman.5.d/50-post_wal_delete_retry_script.md 0000644 0006212 0006212 00000000573 14172556763 022226 0 ustar 0000000 0000000 post_wal_delete_retry_script
: Hook script launched after the deletion of a WAL file.
Being this a _retry_ hook script, Barman will retry the execution of the
script until this either returns a SUCCESS (0), an ABORT_CONTINUE (62) or
an ABORT_STOP (63) code. In a post delete scenario, ABORT_STOP
has currently the same effects as ABORT_CONTINUE. Global/Server.
barman-2.18/doc/barman.5.d/50-last_backup_minimum_size.md 0000644 0006212 0006212 00000001042 14172556763 021310 0 ustar 0000000 0000000 last_backup_minimum_size
: This option identifies lower limit to the acceptable size of the latest successful backup.
If the latest backup is smaller than the specified size, barman check command will
report an error to the user.
If empty (default), latest backup is always considered valid.
Syntax for this option is: "i (k|Ki|M|Mi|G|Gi|T|Ti)" where i is an integer
greater than zero, with an optional SI or IEC suffix. k=kilo=1000, Ki=Kibi=1024 and so forth.
Note that the suffix is case-sensitive.
Global/Server.
barman-2.18/doc/barman.5.d/80-see-also.md 0000644 0006212 0006212 00000000032 14172556763 015744 0 ustar 0000000 0000000 # SEE ALSO
`barman` (1).
barman-2.18/doc/barman.5.d/50-pre_recovery_retry_script.md 0000644 0006212 0006212 00000000625 14172556763 021556 0 ustar 0000000 0000000 pre_recovery_retry_script
: Hook script launched before a recovery, after 'pre_recovery_script'.
Being this a _retry_ hook script, Barman will retry the execution of the
script until this either returns a SUCCESS (0), an ABORT_CONTINUE (62) or
an ABORT_STOP (63) code. Returning ABORT_STOP will propagate the failure at
a higher level and interrupt the recover operation. Global/Server.
barman-2.18/doc/barman.5.d/50-custom_compression_magic.md 0000644 0006212 0006212 00000001000 14172556763 021320 0 ustar 0000000 0000000 custom_compression_magic
: Customised compression magic which is checked in the beginning of a
WAL file to select the custom algorithm. If you are using a
custom compression filter then setting this will prevent barman from
applying the custom compression to WALs which have been
pre-compressed with that compression. If you do not configure this
then custom compression will still be applied but any pre-compressed
WAL files will be compressed again during WAL archive. Global/Server.
barman-2.18/doc/barman.5.d/50-post_backup_retry_script.md 0000644 0006212 0006212 00000000552 14172556763 021363 0 ustar 0000000 0000000 post_backup_retry_script
: Hook script launched after a base backup.
Being this a _retry_ hook script, Barman will retry the execution of the
script until this either returns a SUCCESS (0), an ABORT_CONTINUE (62) or
an ABORT_STOP (63) code. In a post backup scenario, ABORT_STOP
has currently the same effects as ABORT_CONTINUE. Global/Server.
barman-2.18/doc/barman.5.d/50-backup_directory.md 0000644 0006212 0006212 00000000126 14172556763 017566 0 ustar 0000000 0000000 backup_directory
: Directory where backup data for a server will be placed. Server.
barman-2.18/doc/barman.5.d/50-barman_lock_directory.md 0000644 0006212 0006212 00000000123 14172556763 020566 0 ustar 0000000 0000000 barman_lock_directory
: Directory for locks. Default: `%(barman_home)s`. Global.
barman-2.18/doc/barman.5.d/75-example.md 0000644 0006212 0006212 00000001372 14172556763 015703 0 ustar 0000000 0000000 # EXAMPLE
Here is an example of configuration file:
```
[barman]
; Main directory
barman_home = /var/lib/barman
; System user
barman_user = barman
; Log location
log_file = /var/log/barman/barman.log
; Default compression level
;compression = gzip
; Incremental backup
reuse_backup = link
; 'main' PostgreSQL Server configuration
[main]
; Human readable description
description = "Main PostgreSQL Database"
; SSH options
ssh_command = ssh postgres@pg
; PostgreSQL connection string
conninfo = host=pg user=postgres
; PostgreSQL streaming connection string
streaming_conninfo = host=pg user=postgres
; Minimum number of required backups (redundancy)
minimum_redundancy = 1
; Retention policy (based on redundancy)
retention_policy = REDUNDANCY 2
```
barman-2.18/doc/barman.5.d/50-streaming_archiver_name.md 0000644 0006212 0006212 00000000355 14172556763 021115 0 ustar 0000000 0000000 streaming_archiver_name
: Identifier to be used as `application_name` by the `receive-wal` command.
Only available with `pg_receivewal` (or `pg_receivexlog` >= 9.3).
By default it is set to `barman_receive_wal`. Global/Server.
barman-2.18/doc/barman.5.d/50-basebackup_retry_sleep.md 0000644 0006212 0006212 00000000300 14172556763 020744 0 ustar 0000000 0000000 basebackup_retry_sleep
: Number of seconds of wait after a failed copy, before retrying
Used during both backup and recovery operations.
Positive integer, default 30. Global/Server.
barman-2.18/doc/barman.5.d/50-check_timeout.md 0000644 0006212 0006212 00000000263 14172556763 017062 0 ustar 0000000 0000000 check_timeout
: Maximum execution time, in seconds per server, for a barman check
command. Set to 0 to disable the timeout.
Positive integer, default 30. Global/Server.
barman-2.18/doc/barman.5.d/50-streaming_backup_name.md 0000644 0006212 0006212 00000000334 14172556763 020554 0 ustar 0000000 0000000 streaming_backup_name
: Identifier to be used as `application_name` by the `pg_basebackup` command.
Only available with `pg_basebackup` >= 9.3. By default it is set to
`barman_streaming_backup`. Global/Server.
barman-2.18/doc/barman.5.d/50-last_wal_maximum_age.md 0000644 0006212 0006212 00000000557 14172556763 020424 0 ustar 0000000 0000000 last_wal_maximum_age
: This option identifies a time frame that must contain the latest WAL file archived.
If the latest WAL file is older than the time frame, barman check command
will report an error to the user.
If empty (default), the age of the WAL files is not checked.
Syntax is the same as last_backup_maximum_age (above).
Global/Server. barman-2.18/doc/barman.5.d/50-tablespace_bandwidth_limit.md 0000644 0006212 0006212 00000000413 14172556763 021561 0 ustar 0000000 0000000 tablespace_bandwidth_limit
: This option allows you to specify a maximum transfer rate in
kilobytes per second, by specifying a comma separated list of
tablespaces (pairs TBNAME:BWLIMIT). A value of zero specifies no limit
(default). Global/Server.
barman-2.18/doc/barman.5.d/30-configuration-file-directory.md 0000644 0006212 0006212 00000001031 14172556763 022015 0 ustar 0000000 0000000 # CONFIGURATION FILE DIRECTORY
Barman supports the inclusion of multiple configuration files, through
the `configuration_files_directory` option. Included files must contain
only server specifications, not global configurations.
If the value of `configuration_files_directory` is a directory, Barman reads
all files with `.conf` extension that exist in that folder.
For example, if you set it to `/etc/barman.d`, you can
specify your PostgreSQL servers placing each section in a separate `.conf`
file inside the `/etc/barman.d` folder.
barman-2.18/doc/barman.5.d/50-post_recovery_script.md 0000644 0006212 0006212 00000000167 14172556763 020531 0 ustar 0000000 0000000 post_recovery_script
: Hook script launched after a recovery, after 'post_recovery_retry_script'.
Global/Server.
barman-2.18/doc/barman.5.d/50-active.md 0000644 0006212 0006212 00000000771 14172556763 015516 0 ustar 0000000 0000000 active
: When set to `true` (default), the server is in full operational state.
When set to `false`, the server can be used for diagnostics, but any
operational command such as backup execution or WAL archiving is
temporarily disabled. When adding a new server to Barman, we suggest
setting active=false at first, making sure that barman check shows
no problems, and only then activating the server. This will avoid
spamming the Barman logs with errors during the initial setup.
barman-2.18/doc/barman.5.d/50-errors_directory.md 0000644 0006212 0006212 00000000325 14172556763 017636 0 ustar 0000000 0000000 errors_directory
: Directory that contains WAL files that contain an error; usually
this is related to a conflict with an existing WAL file (e.g. a WAL
file that has been archived after a streamed one).
barman-2.18/doc/barman.5.d/50-pre_recovery_script.md 0000644 0006212 0006212 00000000117 14172556763 020325 0 ustar 0000000 0000000 pre_recovery_script
: Hook script launched before a recovery. Global/Server.
barman-2.18/doc/barman.5.d/50-path_prefix.md 0000644 0006212 0006212 00000000351 14172556763 016546 0 ustar 0000000 0000000 path_prefix
: One or more absolute paths, separated by colon, where Barman looks for
executable files. The paths specified in `path_prefix` are tried before
the ones specified in `PATH` environment variable. Global/server.
barman-2.18/doc/barman.5.d/50-post_wal_delete_script.md 0000644 0006212 0006212 00000000213 14172556763 020770 0 ustar 0000000 0000000 post_wal_delete_script
: Hook script launched after the deletion of a WAL file, after 'post_wal)delete_retry_script'.
Global/Server.
barman-2.18/doc/barman.5.d/99-copying.md 0000644 0006212 0006212 00000000256 14172556763 015726 0 ustar 0000000 0000000 # COPYING
Barman is the property of EnterpriseDB UK Limited
and its code is distributed under GNU General Public License v3.
© Copyright EnterpriseDB UK Limited 2011-2022
barman-2.18/doc/barman.5.d/50-streaming_wals_directory.md 0000644 0006212 0006212 00000000243 14172556763 021340 0 ustar 0000000 0000000 streaming_wals_directory
: Directory where WAL files are streamed from the PostgreSQL server
to Barman. Requires `streaming_archiver` to be enabled. Server.
barman-2.18/doc/barman.5.d/50-network_compression.md 0000644 0006212 0006212 00000000367 14172556763 020356 0 ustar 0000000 0000000 network_compression
: This option allows you to enable data compression for network
transfers.
If set to `false` (default), no compression is used.
If set to `true`, compression is enabled, reducing network usage.
Global/Server.
barman-2.18/doc/barman.5.d/90-authors.md 0000644 0006212 0006212 00000001121 14172556763 015722 0 ustar 0000000 0000000 # AUTHORS
Barman maintainers (in alphabetical order):
* Abhijit Menon-Sen
* Jane Threefoot
* Michael Wallace
Past contributors (in alphabetical order):
* Anna Bellandi (QA/testing)
* Britt Cole (documentation reviewer)
* Carlo Ascani (developer)
* Francesco Canovai (QA/testing)
* Gabriele Bartolini (architect)
* Gianni Ciolli (QA/testing)
* Giulio Calacoci (developer)
* Giuseppe Broccolo (developer)
* Jonathan Battiato (QA/testing)
* Leonardo Cecchi (developer)
* Marco Nenciarini (project leader)
* Niccolò Fei (QA/testing)
* Rubens Souza (QA/testing)
* Stefano Bianucci (developer)
barman-2.18/doc/barman.5.d/50-post_delete_script.md 0000644 0006212 0006212 00000000201 14172556763 020122 0 ustar 0000000 0000000 post_delete_script
: Hook script launched after the deletion of a backup, after 'post_delete_retry_script'.
Global/Server.
barman-2.18/doc/barman.5.d/45-options.md 0000644 0006212 0006212 00000000012 14172556763 015726 0 ustar 0000000 0000000 # OPTIONS
barman-2.18/doc/barman.5.d/95-resources.md 0000644 0006212 0006212 00000000231 14172556763 016255 0 ustar 0000000 0000000 # RESOURCES
* Homepage:
* Documentation:
* Professional support:
barman-2.18/doc/barman.5.d/50-pre_delete_script.md 0000644 0006212 0006212 00000000133 14172556763 017727 0 ustar 0000000 0000000 pre_delete_script
: Hook script launched before the deletion of a backup. Global/Server.
barman-2.18/doc/barman.5.d/50-parallel_jobs.md 0000644 0006212 0006212 00000000334 14172556763 017047 0 ustar 0000000 0000000 parallel_jobs
: This option controls how many parallel workers will copy files during a
backup or recovery command. Default 1. Global/Server. For backup purposes,
it works only when `backup_method` is `rsync`.
barman-2.18/doc/barman.5.d/50-immediate_checkpoint.md 0000644 0006212 0006212 00000000717 14172556763 020410 0 ustar 0000000 0000000 immediate_checkpoint
: This option allows you to control the way PostgreSQL handles
checkpoint at the start of the backup.
If set to `false` (default), the I/O workload for the checkpoint
will be limited, according to the `checkpoint_completion_target`
setting on the PostgreSQL server. If set to `true`, an immediate
checkpoint will be requested, meaning that PostgreSQL will complete
the checkpoint as soon as possible. Global/Server.
barman-2.18/doc/barman.5.d/50-create_slot.md 0000644 0006212 0006212 00000000372 14172556763 016544 0 ustar 0000000 0000000 create_slot
: When set to `auto` and `slot_name` is defined, Barman automatically
attempts to create the replication slot if not present.
When set to `manual` (default), the replication slot needs to be
manually created. Global/Server.
barman-2.18/doc/barman.5.d/50-barman_home.md 0000644 0006212 0006212 00000000070 14172556763 016503 0 ustar 0000000 0000000 barman_home
: Main data directory for Barman. Global.
barman-2.18/doc/barman.5.d/50-ssh_command.md 0000644 0006212 0006212 00000000130 14172556763 016523 0 ustar 0000000 0000000 ssh_command
: Command used by Barman to login to the Postgres server via ssh. Server.
barman-2.18/doc/barman.5.d/50-bandwidth_limit.md 0000644 0006212 0006212 00000000260 14172556763 017376 0 ustar 0000000 0000000 bandwidth_limit
: This option allows you to specify a maximum transfer rate in
kilobytes per second. A value of zero specifies no limit (default).
Global/Server.
barman-2.18/doc/barman.5.d/70-hook-scripts.md 0000644 0006212 0006212 00000003011 14172556763 016660 0 ustar 0000000 0000000 # HOOK SCRIPTS
The script definition is passed to a shell and can return any exit code.
The shell environment will contain the following variables:
`BARMAN_CONFIGURATION`
: configuration file used by barman
`BARMAN_ERROR`
: error message, if any (only for the 'post' phase)
`BARMAN_PHASE`
: 'pre' or 'post'
`BARMAN_RETRY`
: `1` if it is a _retry script_ (from 1.5.0), `0` if not
`BARMAN_SERVER`
: name of the server
Backup scripts specific variables:
`BARMAN_BACKUP_DIR`
: backup destination directory
`BARMAN_BACKUP_ID`
: ID of the backup
`BARMAN_PREVIOUS_ID`
: ID of the previous backup (if present)
`BARMAN_NEXT_ID`
: ID of the next backup (if present)
`BARMAN_STATUS`
: status of the backup
`BARMAN_VERSION`
: version of Barman
Archive scripts specific variables:
`BARMAN_SEGMENT`
: name of the WAL file
`BARMAN_FILE`
: full path of the WAL file
`BARMAN_SIZE`
: size of the WAL file
`BARMAN_TIMESTAMP`
: WAL file timestamp
`BARMAN_COMPRESSION`
: type of compression used for the WAL file
Recovery scripts specific variables:
`BARMAN_DESTINATION_DIRECTORY`
: the directory where the new instance is recovered
`BARMAN_TABLESPACES`
: tablespace relocation map (JSON, if present)
`BARMAN_REMOTE_COMMAND`
: secure shell command used by the recovery (if present)
`BARMAN_RECOVER_OPTIONS`
: recovery additional options (JSON, if present)
Only in case of retry hook scripts, the exit code of the script
is checked by Barman. Output of hook scripts is simply written
in the log file.
barman-2.18/doc/barman.5.d/50-retention_policy_mode.md 0000644 0006212 0006212 00000000117 14172556763 020627 0 ustar 0000000 0000000 retention_policy_mode
: Currently only "auto" is implemented. Global/Server.
barman-2.18/doc/barman.5.d/05-name.md 0000644 0006212 0006212 00000000073 14172556763 015156 0 ustar 0000000 0000000 # NAME
barman - Backup and Recovery Manager for PostgreSQL
barman-2.18/doc/barman.5.d/25-configuration-file-syntax.md 0000644 0006212 0006212 00000000345 14172556763 021352 0 ustar 0000000 0000000 # CONFIGURATION FILE SYNTAX
The Barman configuration file is a plain `INI` file.
There is a general section called `[barman]` and a
section `[servername]` for each server you want to backup.
Rows starting with `;` are comments.
barman-2.18/doc/barman.5.d/50-archiver_batch_size.md 0000644 0006212 0006212 00000000633 14172556763 020236 0 ustar 0000000 0000000 archiver_batch_size
: This option allows you to activate batch processing of WAL files
for the `archiver` process, by setting it to a value > 0. Otherwise,
the traditional unlimited processing of the WAL queue is enabled.
When batch processing is activated, the `archive-wal` process would
limit itself to maximum `archiver_batch_size` WAL segments per single
run. Integer. Global/Server.
barman-2.18/doc/barman.5.d/50-post_delete_retry_script.md 0000644 0006212 0006212 00000000565 14172556763 021364 0 ustar 0000000 0000000 post_delete_retry_script
: Hook script launched after the deletion of a backup.
Being this a _retry_ hook script, Barman will retry the execution of the
script until this either returns a SUCCESS (0), an ABORT_CONTINUE (62) or
an ABORT_STOP (63) code. In a post delete scenario, ABORT_STOP
has currently the same effects as ABORT_CONTINUE. Global/Server.
barman-2.18/doc/barman.5.d/50-pre_archive_script.md 0000644 0006212 0006212 00000000155 14172556763 020112 0 ustar 0000000 0000000 pre_archive_script
: Hook script launched before a WAL file is archived by maintenance.
Global/Server.
barman-2.18/doc/barman.5.d/50-pre_archive_retry_script.md 0000644 0006212 0006212 00000000670 14172556763 021341 0 ustar 0000000 0000000 pre_archive_retry_script
: Hook script launched before a WAL file is archived by maintenance,
after 'pre_archive_script'.
Being this a _retry_ hook script, Barman will retry the execution of the
script until this either returns a SUCCESS (0), an ABORT_CONTINUE (62) or
an ABORT_STOP (63) code. Returning ABORT_STOP will propagate the failure at
a higher level and interrupt the WAL archiving operation. Global/Server.
barman-2.18/doc/barman.5.d/15-description.md 0000644 0006212 0006212 00000000420 14172556763 016556 0 ustar 0000000 0000000 # DESCRIPTION
Barman is an administration tool for disaster recovery of PostgreSQL
servers written in Python and maintained by EnterpriseDB.
Barman can perform remote backups of multiple servers in business critical
environments and helps DBAs during the recovery phase.
barman-2.18/doc/barman.5.d/50-reuse_backup.md 0000644 0006212 0006212 00000000747 14172556763 016716 0 ustar 0000000 0000000 reuse_backup
: This option controls incremental backup support. Global/Server.
Possible values are:
* `off`: disabled (default);
* `copy`: reuse the last available backup for a server and
create a copy of the unchanged files (reduce backup time);
* `link`: reuse the last available backup for a server and
create a hard link of the unchanged files (reduce backup time
and space). Requires operating system and file system support
for hard links.
barman-2.18/doc/barman.5.d/50-pre_delete_retry_script.md 0000644 0006212 0006212 00000000635 14172556763 021163 0 ustar 0000000 0000000 pre_delete_retry_script
: Hook script launched before the deletion of a backup, after 'pre_delete_script'.
Being this a _retry_ hook script, Barman will retry the execution of the
script until this either returns a SUCCESS (0), an ABORT_CONTINUE (62) or
an ABORT_STOP (63) code. Returning ABORT_STOP will propagate the failure at
a higher level and interrupt the backup deletion. Global/Server.
barman-2.18/doc/barman.5.d/50-minimum_redundancy.md 0000644 0006212 0006212 00000000133 14172556763 020122 0 ustar 0000000 0000000 minimum_redundancy
: Minimum number of backups to be retained. Default 0. Global/Server.
barman-2.18/doc/barman.5.d/50-max_incoming_wals_queue.md 0000644 0006212 0006212 00000000374 14172556763 021144 0 ustar 0000000 0000000 max_incoming_wals_queue
: Maximum number of WAL files in the incoming queue (in both streaming and
archiving pools) that are allowed before barman check returns an error
(that does not block backups). Global/Server. Default: None (disabled).
barman-2.18/doc/barman.5.d/50-streaming_conninfo.md 0000644 0006212 0006212 00000000256 14172556763 020123 0 ustar 0000000 0000000 streaming_conninfo
: Connection string used by Barman to connect to the Postgres server via
streaming replication protocol. By default it is set to `conninfo`. Server.
barman-2.18/doc/barman.5.d/50-archiver.md 0000644 0006212 0006212 00000000720 14172556763 016040 0 ustar 0000000 0000000 archiver
: This option allows you to activate log file shipping through PostgreSQL's
`archive_command` for a server. If set to `true` (default), Barman expects
that continuous archiving for a server is in place and will activate
checks as well as management (including compression) of WAL files that
Postgres deposits in the *incoming* directory. Setting it to `false`,
will disable standard continuous archiving for a server. Global/Server.
barman-2.18/doc/barman.5.d/50-slot_name.md 0000644 0006212 0006212 00000000307 14172556763 016217 0 ustar 0000000 0000000 slot_name
: Physical replication slot to be used by the `receive-wal`
command when `streaming_archiver` is set to `on`. Requires
PostgreSQL >= 9.4. Global/Server. Default: None (disabled).
barman-2.18/doc/barman.5.d/50-backup_options.md 0000644 0006212 0006212 00000002055 14172556763 017260 0 ustar 0000000 0000000 backup_options
: This option allows you to control the way Barman interacts with PostgreSQL
for backups. It is a comma-separated list of values that accepts the
following options:
* `exclusive_backup` (default when `backup_method = rsync`):
`barman backup` executes backup operations using the standard
exclusive backup approach (technically through `pg_start_backup`
and `pg_stop_backup`)
* `concurrent_backup` (default when `backup_method = postgres`):
if using PostgreSQL 9.2, 9.3, 9.4, and 9.5, Barman requires the
`pgespresso` module to be installed on the PostgreSQL server
and can be used to perform a backup from a standby server.
Starting from PostgreSQL 9.6, Barman uses the new PostgreSQL API to
perform backups from a standby server.
* `external_configuration`: if present, any warning regarding
external configuration files is suppressed during the execution
of a backup.
Note that `exclusive_backup` and `concurrent_backup` are mutually
exclusive. Global/Server.
barman-2.18/doc/images/ 0000755 0006212 0006212 00000000000 14172556766 013115 5 ustar 0000000 0000000 barman-2.18/doc/images/barman-architecture-scenario1.png 0000644 0006212 0006212 00000536632 14172556763 021441 0 ustar 0000000 0000000 PNG
IHDR I sRGB pHYs gR iTXtXML:com.adobe.xmp
5
2
1
2 @ IDATxU
"H7HH؝]u5vuٱ`"J HH4*s;|Sy:39y; @ @ eͲ0 @ @ @ % @ @ @ YI <+/+ @ @ p@ @ @ JYyY @ @ s@ @ @ @V@ ʤ @ @ @ { @ @ xV^V&@ @ @ @ @ 2)@ @ @ @ @ @ $ IA @ @ 8 @ @ d%𬼬L
@ @ @ @ @ + geeR @ @ = @ @ @ YI <+/+ @ @ p@ @ @ JYyY @ @ s@ @ @ @V@ ʤ @ @ @ { @ @ xV^V&@ @ @ @ @ 2)@ @ @ @ @ @ $ IA @ @ 8 @ @ d%𬼬L
@ @ @ @ @ + geeR @ @ P @0XvYzYfټSRiSrYӬFqfܕͪ;6ʘG l Q֔*O@J0-/3ٿҥ`VL @ w/39 %^f[f|q̩mfl}0< Xj?SҦ~rO'3 .r;SWؤzysg&{μ9r 3{ XuvSӷg]>kO;M>Hjvcv&
1db*v*a @ @\xC! vz'ߛY6١vlX1CVad_&!k67OdJ_t?qzݿE5qލ ,ǟNZa4lc-WoL3^b3 @ Y IO4~O\fo
L3aޏfڟx )yqB/t[ۻC/$CeS #6oyF!G$0E Uؾa-Ԩ0%J' R
x$q{K
"A\ލWdBu E&t%-#wcy\7ƅ;ywRӵi%[^ cv,RN\ 8%~iiTuU @ <`Y]7KLZS:iZq Tp#z+JaתnrIGV<(4km$O~a]pӟ'u[qv?۷L]цmw?z cUq/Vz&_e gRO{7Lo{ 䟷2SEq~ސ'L k6s%kC/ 蚉l/ R"S1|N @ @8 #pޱ5F['Dףk]UXi5/aJy KFݿv274 nu a.EFC .At ;;X?>I)_;,I n]\9?z hN7Γ]SWZ|ڸ
`Ul3lsmu-(꒮g^&خ~S֮;<^^*]+-/bUJS&ƉJ9 @ xbFԀ D\P:}h' (5y l:DZb]{+ @ Oe Pݸ9r,Ƨx~OWaV[[1o?m3ט>LB(i1I.e U[tЉ<3viʂ
;"ڃpo^$ukm݃gw kD"^rPh{={bVhF?x|],㯟Kߜө;̓mP^~pT$ 똫^GK~ʓ$٨iQڴ헤?,'M7o6>9 @ ;{tZ 8a3֘kI\Ώ[̱%#]=-(%;ӣDC0>"r/Jrj;rqQe @ ^xe d1-0%^ԥ"y*z 8v5}Fs_^-yu|tSd=b{(CS)҂<:YY$ 8r".sڟzk9 r^F%80nYYj{<秳'<C<ߪF!S>zYtIg o\d{z s}w(u8c
ׄj
O^azQDj§Kg5g
W^ T嶎k-(:yzN>{/Rrs?
b{Y:敡 W
~3֮af~O~qPJ
(>|/κkORQe k>C @~:.4? @ prc a=n!s dWIH~F#GʯqrqKFF=^:ڴ'4k/5u/KBO]-Dp N?[/dN:Vv"U[hLS敍^|)iio~}3l(2y @ 1 @ !pbԄ)9bTwLuܟ1wKEqi}M+-e)*xxG' <%cnҺ Yh(NR/dɪMEOLWȓ:Dy
߾k7͖M;-ڕʚ^8y(/zbY^o]Rj;TV{QlEJ*Hҽk=Ƴo6Km5>MI ŷ!eJoQe oNA @8@ /NWB ^ q%yF٧I>rZ*IWtv5x k A @ @'ݬϏ@ B`ُ3)'BՊC"e
ACG:wq @ (. /.WyB |z qf=^ྡྷ]ߏ^vCvT> @ @ (\%@ w߬b:^kkZթ @ @ @Q ^c !-H8 j/ 135,4 @ @ =cz(f͚e>C{b8{ jSjսA @xW/:@a&PN s!26@ x Icǎfs>_~9}9B @~hҤ={v~tE (MfZhQ ! @ %YZ@&i& O7UT)0}&P
! #pi.]Xt @w57n46/ cb ?gNň7g1L PXnݺF[ @ ; G>#3sLQL8 6lݺ z[n F`۶m^իԩSQ @ @# ^. )oޔ.]:eƌO> l$Ϛ͛7۩ s1[n8M PvmߢEW_}e7nlXL8 C@ H): -_|經%JXߣpZyCزe%ܹO@cO?MLB @ a B &D<_7onʖ-5LyJ^uUQ @ (4h`?pvZ3oK/T⦷~ۊt9Xb݃夓N2ڵgm۶5{*Yw}9]|~}qK Hu|n0SNA~g qǛ}7+V> " 5jժK.Œ?st Y.%-؇ @ ~*_R@ @p _yJM5)DO? SV{{9\%`:;VDƏ ]}y{_!~DF 4rH_Fuҹ'O}$+ċ{@ N d؉.
^ rHBKz5jIvIz"I/j)7@:U. @ @lP@ H&p] hhUυ#ѱ|su%Uy2E)؟~;|ߚu_JDqٟ^Tssӟ%~댃>_}@ @ I@
=r F-K< .qyESYAk] I2` w,?NNTU?/X/n|7Ò+m^&!K|y܇C=4"ZL2TJe|U߱\:<}=F;isbE{W^ywssӟ ࿑C @ fC #7_Csrma;?w([aK䩪, S.(Mk5v/Fb%(ZEaYtkQ
/,7alRR/o`C @ { e _3a)?)^pp7ZQS\`ũo߾QSn,-^O Rɳ]1;9e<_vM+ 2%
]/k֬Y SsRh#FD
͛76=ny
W{ɒ%C @ I@ O @ o O=[7ja.nB stRۤId/zk֬ "/XB`4vS@BO>h efBaU }ګ^`~JdF^{m &D
{$_u#.cXIqLtݖxq3R ^߿O ;J×_~ރ*B~(uf/_nY)s _@ ' O$8i:PJxcc5CmȻ駟^j*[4lІd yU;lq (YySN
_$27IOyK\t" HKy;Xc;̀ļz^?1cK :tpy-C|;YȊ+JѢK."G uTIoOIy7"opy#rvjct;qXDtM}] '^Suǹnꅍ~}-r){ 7~uб| @ q f͚Et%/Z4D Ǐ1Z rJBqhL<9">ʋ%Ց;(BdG F .E%dK 0a+ʛWL 1(!s;jS~}n:;'Ŵ KU ww8Pz)|;vheo.i <]TO/R=p@{/ ќ]jp:,sE^Č ;LzvGӽO eՑ1F @ }; @ ' qωqPJOJ#V%/s
FVs\xm}EE\/]2mM
9kгgOSzuX$$|_q9Y7}1e˖1
yJ "JJ(o>#_'oJ 7c+ԩS'/r[T]K.Ĵj*~nR 9]w_ͥ^jw U,𫯾:.WŜꪫr,=jy+#=jR @ @ }z{ZT R"FեKΥ2;^z)ώ*štyF+܃~QbWxb@²¼O&S > \dz;u$ʋ RAG ]ɉw r'F< *UXA;Q; Y}VP!c35>˖-{vNGP}} 'zI(v@}'fĉ wqeRE9 6yN&@ #BǫΜ! b
kH /pY\reKX_ )>%N2%2D.Vu$Ϝ9 Z/o`$v
b+NiӦMfʕQ-[' @ (@<*T0{e˖E幃K. @ @ x 'o]t1
B @ ͫj
P??aÆV! @ ( %b@Ϟ=Mʕ3YӰaC+zq-x衇^zY!;n%>Ӧ~F_5jȨ}څec ~wy4k~W#ѲAlٲm۶6LlvYq]})sm&> r.W_}+ |9lAv^9:+VG y$>fժU)Ce@ .{FsN#O^?9ԩSয়~2Mf_|<Ν;ѣG~g6:u2 ~}PEKzi@ @ A@ ͛7rV^mn̟?ߊa%f /Мzfǎ a"y/6kǨaI,u4i$;>}I<}'3k?̮k+n۶-+[<δ 3ۏ% 2u'8 A <|p͚5?Y3
F0Zdf1ւ;ϔ*U*.䒴?5 @ zW]u%*S%\aXڲe OI%7qDӢEWscKݻټys*q% ZEҥK06{^0?nܸ5vش$@ w͒ >#؈>o[B'6l`Qd<ˇ LլSBsi嘓⃓ @ @~Pdm6z7l0)t]X%Kڰ%,9,
6+馛̙c! a!ࡐ$2e<
kX֭[L5@ "&bus=fԨQvq{`r4Q @ OZ1ekF_ p9 j _|1eN8
Mзnj f)H0
8L0!mW^D7xî7}?G%pk%qnmL(U|yiuI (;9= ?>*4G>}lniTF҂0?{ލțWzБb2Zk ~pjx+W6ċ & @ @"]h6/^~P 6]w]y)bŊ9IP?mx$OtbqI6 w#[-駟jժE.b/к?IV =zc#G(WL+G~Aff/ȱtb&G @xfdf=ܔǴ>bS> @ ( /-AwԩS'fk6@@իW \Cu,/0cEC˔)Sen 2'|r)-L}G):x۶mFOn^uϕƲ)O?Sdo =t ҇ ~hfΜڱ kH,L)6{aO~iӦFB7~W2@ xv\Y4h 4e s1D9 ;GaL Vtjq$Žos&M֭[$@ $^jذah$o-j9tP3uT+z`M)xq9r光*[d_l2aX3zP?1L @GiZj,^80ԸqHy 9{F ` @ @~8v[0OFNq yW_to
(L Oƛ;dR,T)3a( wK_ (c@ P$@ ,ńbM-v/W B%LOk&m}^m @ 9 Z=P/W\Tց"a¸(g
}5ح[7sW" X=}K} 7mڴ ׯ4iyw
!
¼! @8Hdg:E|K.;}ҺbŊ uj֬ɓ>ydB$ @ !_9f'5zSZѣGO4w}6lٺu+tjX
@ (6~G+t} eG u^z$ʔ)}SbEKd&Mzzr- ^~}T_:СC`Fǎ # }j\tE*vQG }4G2 L -'|2q&l:r%ѣm^zElw
+͗_~iM
@ Ř !Pw}F \{Fs*ͅ^j""1\q B9餓g2W^^Qs` DO?,YĬY(̌<'ό<?ps[/F @ QNy*q|L"u>}Bq Q^҇ vX"~m?9 w^ǹa Z7jǟFa4^9W x_K]vI1· z\r%QږX LBOª IyJr
qnmdNh$=eG/G_{Ϟ=Mƍg3 @ K <y{o2؇5jX#L|XҧW\qE[oz^D~ ȓ[13-Zd=GF i?UQ _u-cZJ2>M}d@ @Q' Y kY ?#| ,/7g}ESOY% z L{Q`#)Kŋ':r@ ?Ӯ]3'3QWHx92*7Q$qu &-+N6ɱBjnt+SCr2'JzG aTtS&mty$j+νs9\ޖsQ;=+g ذ9K߷o_3o ^v( @ =[YH@ /
K@3_ʑǃbH֮]N!9$#YBlڴ)̋s;0Bӟ̐!CqdH\yL6
z7*I] @P'ꪫlL$AI[PJ2C wSƳ]2\xR?bAdΕ,)y+JmRvn TJ @ @r
͞܈G-~ԨQ 7K,,nw^deˡHO/]!u2(eE y*f}Z, 3wygjP1C--*ZY:b![ w,τk+[GPʓJ»<e˖YfQ @ ($TvW|SڅS
S(ɭ$Kv1F-[fá| -z1`'H9 @ I@*UyD"Flnڴa>[bтA Lrdgӱ<ѣ`8%UzYp!Xm{A"_mSyL?_K 'ˊQ)-$p @ #y|?4_~-'ZIVWn<-JqTd B~O
/0
#Ot^J $O jiH
&rKwuٳg*ELƫz
rpFOӧOٳg[/sDZWƍ8,?P! @ YC@/r+ p x 8! 6_|ObkA^s^ӯ_`Q?,oΊ8k֬HsqΝ7<4 *wzˇ'#Gֹ
G Y37pgT<A! @ "1cyʹiӬM,9h{ǚkm {d7ˑ%Y]^ܵjղ(ǍgÜklUʔ)>"xVLN ( **$N?)&]Dp\x̠As|v 39L%7Ȼ[$E.Ox'^ [ ##
a*¡H-#1}6oDI
"l #<\}ն-xE9 @ @rfOnŧl^>tP#;Y3rIvݭ/0[\ ~iDQ
lwy+ld+ kLT*OcSD_L7M 2幭2h~WK$/v/1\ױkր 8! @ 9e'7%7nҤi߾q0H<\++٭/Kmo=s$J|pRKI'd8 N l&H$]?9 }s1gq^z2S 2T(VoocʋD+P^={%}.0VXiW'CZ^$˗/7˖-^"2QC Se˖cǎsϵ7 @ rPor\]+{6Y]P·TٸR";9^y2\^Dx^:}sռE^OJ b@ YKY{iX<26%3C!CqYoyFе(Z3ק Me?
ȆU+Vhlժ]_ ҝfs.]}hfyv/ doܸI0ա j2$|XK Fyl~ՉW L2`cZo+^27nl xӺuk+
xP@ y/Xz|v_v0]<_x}{SB`ɫxL/vsL.!\?yׯ_` ! d𬺜L& D {ʕfӦM֣$`d %xvⷿDi<xu㕩x2}B)}] @ @ {S4~W_5
w3dHqBȱHu卯
rdQq= P /HkWeI\߿]0Gd \2pꩧŻ 3LU +AIT깭ߕm2ՉW
6TB+w}z0'c_~ @ { vݨ .ХV HQ իݝXɜ:OT x+K4&wj!CXvl{ʲP P K coW^yzHO&ړ1'ފOeP;OX`|cՉW V
nՍWvʕ'gZrԨQS˰X/&QH={ژ4O=y @ lAY'
}IN֭M6]c<3/4TۍW_Sʝ.!|ѢEfvO6Tlwe]fzeZ- @0@ /W1%0o<2|bӽuXB/2R,
+sD╇s+XI3Yf͛7'pARre}ViwB K@_
* /`D q%PPo֬i߾}$RVMT'dƪ o WUO*.(""
.喙YYN3ʹ75ʩfڜ2'M3+MM\IMEPdQAܚ}ϗw{|{>yN 8'Hʡ໓Ȳf_DM;&al4:da7=
13 Ch.X
M<H:~iIԩS}е,Z{%1lzFK!fe0hhbOO8|(kf;8éN < ʪu֊#m0 C0 C`C ?Ry;w_-H"eZK"ؠ}z@k}iFhr Pv )OHRڵk}yس;v_~e udp7 ChNXxs6l.Pӛ*iӦyNjzy!N 5q z959OkyBo*Y}L\8Fˢa7i$=y+o#GݺucV ]|E|w缨7nWzZ!`@c#`FF?Θ1qҜP135X2ɮ
8cФth1Z<٢t<~O]I0'G uVAN1/,x q#
{,7 C0 Ch Inv0/*3'x 13p@oLWKϓNOָ̭,=_GtE /.)R{}̘1nĉއ'H?s9۱!`!X 7{ KZlp9o<_RvEQ|@8iC&X7'm?666<=6vyYNIB\;l
N9/0(Y#;/1k0 ChJ엨)7۵cCE
pX.9yd 0-deR+.YB c]k2ꤨéD
fn(bOz=ц |8$N@|dP# ={(ښ!`!`@!k.ᳱ?O_$M p {#%L +4?+v]f2nݼE;{>84߽W{ K$;6 Chl,7{sW\q(GsE#q(Å,-1ƼPdP}ѢE GEb_G {!s0 C0 C _}ϯÿ+3#^x/'<05>'k\dBh3 ϒ-rMȒNSO=}w2@?{]}9>1 7 C0 7f# YSLO(Qԁ&'Lۑ ԓrƴ.9c4ׅ^T6OS14c|©1H ,-H,:4Sa;1ElJ9xߝs>Ć4[xx O,qm/S-M_3:z>Z6 Ϣan_VeN>Ci"ߝ(|秝vZ榦Et!`!P
^jM+d,Xy tӦMY$d߿M9q%CX6@dXY|i"#}OlL˶PVޢv&-;;u +SrlٲQ/{:.:"g}g q ji؏c1Z]ѳ5>iy;4 }{_eŞO 5OV٘.6dYG<4
} cApCO7x?ϻ$c}y8{M} s1Nj ?#Ho膀!`!`c7x{Gܚ5k|x pR.r}d'?ҪhysΣ՝ǧUc2Bcu ۷o~ҥK݊+sI`
ep gZB@o r i/BB }BcqآOƤg\^Z07 o>?;"2z qCf
y.CSD^gJfM3MK4KM~݇|
C7m,MGX _Z i22yz-wE >;} Y+رc 5pc0w{}U=C U(#=E/AΥcip@yxyL bnذ=n 8ioCQ"5$&?L\~ʊ\][vSȆ6 $1pmqoEN'p;S]Ν+Gc|ĉ+,E_a~!cʖ˲-y9Z\0W'Y}LVqq=υ{9Yk<{>sA@9s>r ﾻ= kŖ=>!yT96 A2G d7sL~g iԄ%\O귮 ~|b-Fh1 ~g^z{1< M67:^ L(z_ȇr{b@Dk7'M6믿#e˖I6+A֭[W~pc41Z<=e'n^d Y;ӓ+)Y(,q-œ5.1z-mLt>.ƒa=4>|w^6ʔpI`a'/V%%k ߩ|:-I'KWv87sNE|:ߔG1QϛZ' fsX+P~|tA?>eS]YKkYi J6͖"vOB'%d`ᨱ3=ey^|Efȑ>Vp!`!v@ ߝ\G }+W,܊@VZ}z(SH$%+ڵkW+UʡZYyEN3ߔo % t~'hS0"X <#@@:m>w :qNjfV?&G YZOsyrmr,TzM![f8G} ~O{'Rc]y &;,,{8+dpD/Xg,aG ޑQ!`!`#o*{ ?}>
¦}9Cy(/ZcEml s3ZOsKF÷fzVHj}&lw̒nݺ7 C0 C0)&wg8Xy\$ 6 |0@8| O=k\hyeb/K @ IDAT?%
ۇ`ҥK|H:|" /`HdVH[>HOPg%C/i vn wN=T>yvAq/tfxΝ (尃tl;q' 1X%^*8G{ՋF J-/ꮺ}S ]Ags$L6ԽF 糣+v0҆u uoV7k,GɓիWG3o5@Ov={őnyNXˇo 5;4tn*Cl7ĦdW gSqc^8ldeT9oCpqnm0 C0 %'n_vbҤI>k7a)Pw'\|r ~2 EG(+"4PVӐ/KϲxLw'YDVne.$~O?Ӭlpd V|"g}?[BpkuC@{7OI[uNMυ8`@V^dfw[{ quxR{ [T\Cⴥ[9{=+*U݇~һw_4}
3$;d_SV_}d 1ƹ'5<X'PHPqyXp{ϛq=lpI-PB th1 3)l2]
uynzl"_ ">8<;Q,f5h7oϦȑTN" {Je݅0sgk(\+ ݸW%-6})ϻ >rzjUԋ u^ڗ;v>qS-cp x|ʵ=݀ '^arNOOw/S 㻷u;t_xѭظgE~3;=+NA?NNȔ曽 :g>3Sqe\]cWthz&Y}lS==uL= Ew(+ZNѵ ǚcڂ|)?{l9+yy:0Z/4rtO?+|F9ι5C0 C0ywy馛| cE>|w2iI*w dY/˸з e5 OHqyee2';4xciݡ,]cg} VSbs=+z)vZw7zK.q^x_m,|W./xqzH^ýF V ?^W;}nR*g ڷڳƲ,eI]pA^x@1e}!`&~_0 s6do}[>8H gZƏ{R?E}w.fĈnԨQ<dj? >qMXEqiicBӲ
OHqѥ1eZoP,4̜S]b['yZ~{ߝU j*N_(ý/~1K JI CoM\?c9亥g\g u=;쇆Lέp;v&_լO2':
]-\v\ l8~Б% H0yㅣI
ki^}-[e 2-dQ#uu{:ɨܖ$g~<ߌe[~6-ݐ^5Uw%iq0{- Dnçv
*<=|-[a}w =+
_?(uͲ?G%-=x7ߍOp\r} 45u wx% s_^F_;MN]۸a8Uv 1w}sfg~Sރ3g~1>u?0GȲpӣݡnw[ 7s:^z
o&?/+=_ qi^&@ pg
S 'ۃ}Arzױ g t TڸZ3C?8
ā`sSț]c@S+෮v
)?<ҧf!]l
MqyqXe˖^ _j_>̃9т!`! !9}ɒ%~szw|A)|wWKw$n`ﻇAz|+.6uMr/sRQ"D|wV7@Okg*^Q#~gcbEgrm<r/ xC<+NO6mԭC+k_# O#u Ya:o~r ܝolw{O\} wjI_:CZxz4'oMsg] T17~;ϭKGN$ӼCZP>:-:>i55%MwD&~x|J ūw&BM|s3A?K?~>SG#L;N2
wyV #Ҋ e5=FC_HG |Zol i[YZ>+Ͳ';MNhi6zOENhZ>F?$M74=2xEf(V5 :pY}k_k[ C0 C( ~SZb/
79 7tP 4<i&) Uɇ 9a[mkr}pN s,NZ\(/2uƊxU&XP+}Hg,+~==dT'w7?.t\o/ 7p)v.]s> ~m u{$ɀٛ??&)rdӦ,X+MYw
;* qS߫2*e`Sԟ9/ \V+}rNcM/~Ndsx7w^iII6IVKu6y9 罎l$zNO ' .施T Z ڢa{!7 o PP-_g<,N:$_OA0k$1
lhyXݐ (:P.yȣuh+C.e\OY b_6љ3g9/cƎ SއlxiӦZ8 ɳf!`@s@
7_w)zWj^|ũ;z˳)2 u4GpN\wH״zl(i19hDGh8ѡqϊ
ddrSW^眲>erDK/THW 3FϹdI35HlC^r|$q]z=0SK7yIiNJ2LnЖ&uJ\di+g:%eDs?Fm?[9W9OaM 8<,:/n.]W2Pۻ?ލ 9gYfNcƌ5.'[7 dVߚ!`!`M e!p|˳e8ݩܽ{w_o9-xw\ai."O(iyt22f?ƧiEHЕGO'cy i b#bt|lP3jȐ!w <;;8t /`sGxV (߿< \%@\-ŵq? 8=ciq5|l&L 6b/^P5NO_ŕ`E|
X_=o:9: ^N
t#\XJ[ƮxG'[yy%z^i۱kOOѷ
By :rx'tqO~,q;k ]Zk^ݗ/ PM@_דR,E }"Z"`ſI%d/#lGIKg j{<Xbc?HQ}Eb6 _nW mgvǎ ~$/q(]M-zI=;uڵF8|1{:/;4]6f!`@5$g&;A"/sHTT!~ 'Aղʆu5)דe!3Ϧ~gSzWs_{LoVlߣ@?c>;w>=sAWZΎkKqcsoʵɵsO
&u34-rW}wl2#Ȑ.
[{J氃֭d LCϠ ݂$+F0d
F?(_ F-lC0Yw{Nd ݩejm@dIؖЧ>oXFojg? {'%#me[%O=9v@Z '~] ^ٺbLtɗoeo|, 7EX,ܼy/kx,u^
袋IP˘֛&^MKK 92dEgV/y6 dzlvC"6 ?XjyqDX"Iܹsݲe| 2D7nAsQGyg9MlLf;1Y!`!PWw{}/lGIoѣG1S`z FM<3d5=ԫii6OO( XEgL6fSˆ65=LV t~&Qy̙~%ԬwѣO\EG @ :BYn \* =--}3@RUĩU# M'E{V.: =rV$z̍o/o|
3ݤ5?ҫI C0GY"msR[.kJ1%V ön۞2 9vwZ; mpNś
4:d{> ~H uo ?v0^lf3ݷ>4$cCQi|֚ 7-j}֬Y~k "۷7\H_;98v4s-Go*Yp̗Vt^i124qdh!1
zv@'Ov#Jt6#v\ 8sWlwCzO37֬cէv &a&ހ pj~S+hY%(%A`_~>Zla;v?eo*Y/s)23v2zem,Y,Fd$N qRy;vX܉g C0 ChQ}6keEOY EZ]|;k2~lC2 }ל_暵ƒ
mƮgNw|mW$Xo˱?ۆuɵqrLOl9oYhPy|&IMl]~㘷J<%[W\4^NÏ.cOOJvOU %>ii3tZ;vsw+$>5E=oeNQkOQBdN(s=vsUS*ngV2jr5J#툶KN!7 o",Aʝfgywl878
dAuϑK :D?Wh\ Sˆ864;/*[e\髕C.i2'A>#N-nEٔ9$pjFdl>|Y c)|f\3decI?4MH6sl}h G7ۿ_F 1d_mn2=:y}K15$$WZ'c7(Q=k{:8hO 2=vЮ]O)$@:&_?ZUO6qilM sI IɒG9RJFs?rkyȞVL4xrUE ɓaCw7Nw[e_
5Fʿl~i %בQ;-\{ $crI'cb(+N e<ϓP; [T^֑'[#olQXҲ1zHrʣ ^[cef,'M-
Щu{}0 C0 ԩSݝwn\ʵ=}{NQ71 `7<ΓPȆސ^_x'[)K橋l:6˸4$ӛY}@[V1µil3I r.}3:O$M^㤏5d?{q;w,f~AwΰnGwWlr 'v=8 ӿc ?wO}#->_CL?pJ#sZ+o'%@>dwNj~{?<ʽZMۧp{lk2|5߹ldyMV+ HrL3 NO؊ oOiG>HR |;li"mn]c;&Y]eqg]HE$V^rpOv]u.c8e\vdzC0 C0J# Bi7?Oݼy ";~ ;AD|w&;2 'œ5 s L ҺR6Nv<ѝuZߝgQWVZ}[z{]6?cwgn\pÇOkI 7n\"H~r>|x _>\^##?iu]sW^yT2+)3E
^6JsV; =n~퍿IkjRq%I
];ml|ɦ6cvnԱNJ 8;E2ZZͤtʖ$y[" ݩee#Hߒ߽L{*5x R7\7& ޱQAWp)_,Ym)yҷKke͋,Y=7_8nؾcѧs6t nCVJceM vV]wS7)z@" hZoxܐvcc4E-sZw\?z8rL<"siБj9O>_6i&??JPZcƌYd|k͚!`!А,5\}w|y|~
V]ven>%tM1 i2.|!]n=8٨Z|4uSo0Coտfͯ^e[rC| l'"/^J6,-XOecuGuǰ5 4i~VXHx[soũ֡CZos#:hȔk;ᱶ-J[F6SYxZ|M㜖œ5^#-FO+|dp?S+pnz`]V AoOV%= !`!P {nrkJ7ʽi)d!ӤԉI4=q^LVW^vZwY٬k-;gŶZPVˉ< Ɋz2)OH{ƌ~ Ƹ >cMe3acc4=G;6 A`]LU;ܻGu:NvAw'uSs- se^dȒ92m47|tid0SRdSZ26V4-gSH7O^sk]eDȗ9ey ~?/à ˁ |{f7/mLח,vb!v/:828k=КJ> @Ko ٳ0`A̵7}i!`/G/~ >}FYBʝv~lڦ혿]į>lYYW}ɢȼŶ͓>?mLy}1PߝzϫW X7oݻw/iN92!:y 1Gg_Ӯ+BgV_;}/ֹ7 aSJ] ع!P
Fy^xя~}|AN
G>w
}Z c
[1z&6wk9ž 2kPVӐc<ِ ݔa5{p9'wyIфzC0 C0 :/j";uI
`˴`"/.ChXtn~SdI u[_IJ!9wlnm\Êo0ٰ35oG, Lu
6|5JDPo3@@ʝ<
ȸh1Zl&M >M\dNbzZl a =뚸w,Y7ʡ ;f'^}
'tC!`!Pd ~ack5)u2qD q_ ! hyitƲZb4SFP>.2i-O.FVGӲ7\/O{РA>r*+~V |1^
C` m eC ҔCY&O?sK(Q_j@lFvm1dCb[ u/*^CPF.s.bWsBcwx|r_'L6AoѢ#1ziuMgc!`!F՚ |Snq*"~ *oӧd!w.*m -#[\ݼDyGu "'KZf&eOX*b|{'b'ϳ%x]dczf!B懝X3gt]ww<
K@"
dKQ
[!3C:/)w"+6O{ $-濤`Z^C=L ɆvC)* /-ԡ5M1&i)c&cv7mw}}!Y# v )oJ#M1\0f!`@5PdَsE&+bzzؔ)n rS\;/hyć>}\%}}OcC0[ú}6a)弮fzpr1zbKږ>ukdlܸO= A7/hz%Ǐ6mreyGo 1C0 C0@`Æ
t~2oK|", .B/ ?_MB vk
Z/cy5=Y} PwE.ϒ yt^s稏1;%NXu9f]! 6>|2d8۶m#bSV [J@8h@D1 =]1Pwl(<ҝ5Z 25pN \z_@K-ZK%O)uBm۶^#}ּdE!`!` qe[l$!HdVQpCJ4BCc鳮);FC_ =fY[Iic!]Ӓmq`}4 o/yg@
<}1K!
m7Ml4jqN[%
u/7mF9f%M|;8Mi15g!` ;%#دZó ^w٧zʱ+&O'}oCͲx}[km(؎مضǜo ~o'p%>=ªbwVsf]OC^8Z.
俪l[j{f͋mGV.K!
n 7݀ ۹L-an7?#W_U w8KwCڛBEVh[2)Ôdh
{ܳ;U'Eqnݚ-Y_eRotK_z&wdCև礱1 -1kWl|1n & F{"g}1, ^ zz}o15{
H.Jj)㤔 PVc4.Vi {T[ǯsGwl)C NsIY98I:妧`6Lpv2O]?27?ae6l6 G{ Ĵ z !` P^c4.Rӵ\H#FN8rb?ץb49ر!`!`I&)Sﴕ$ӟ~S@c_擈d\1ytx>ΥjzCW^l(
>ZSh7F_/Zȯ8^p/UV&ා =گJhժO~5}h;Qzlh
} \k~7ݍ?nqeC+fֽ&~wWƺqbs`^owz}3}gVeeH?{ҥIF6A;^-N"_MTo~U sUp.$Ё_vqQ~Yv]wb="سgO d 颣H 4t+tcc5-M+nv5Mxd5>톶fN<ܑa@=Iz'[ ;ߣԳ%ziỵH eb4ZWx,҇t;7 C0 7lSfnX{+m @ IDATo! 1YMCg̮Б +fOd5=MC_Ha_DNxB2.:CgZ>45 ϕT`)ޔ*T y$ۛzG/i B=1yPW+'o~~CsG v|%uY8 D;s >8/q=/tWz{;g%ӯz~R伓rv'Rl틞ݯfq>T2;
)߭s+z(O=HwV'X_q{ 8 t[ ]Ҋ??&)%rd給,[ zjcp$e]~p"w}B[͗ӿcޥ= Ca۲e@bV#ȈM6 i86|臎RhP6)l\k]o6:)uB@PR+`73&;w h?쫝C]|M0 C0 [n+>>썂M4>e|o2Y:B,
q2,Bo
D{gL/٨ ߝ$/۷-יW;4]eǚvٹ!P
LH~ʩp/tKSWT/ u'W uJY~laROtҳ£& J;'7S,$jedo|ZeOnn sGts]; ~t>mf_ûO֮ZQ\7^0Ny)1~zK>v@'|=Lr7I[5 `'.( ƗyC#/oǍHpd>9MKў<22vd\fc"kݡ^MC,=&11ZlfYls| YNdLog6:tq7oi[:} ͯ"ر!`!`QlZ'gQfbpiȉB_JӠZlzIe5
= k;MNhѳxlk\o =͞
]M}wwh;!M-z6b܉wopVWɫ۽2PF$]ڊ;!^M|n}uVSEiME{{r0Vl|,)ÇcpO?6;6"l}& τ~ fcqX8rJ& 궵kΗEav4f^7ײliy-˱ZF,cyuCZYEk}5-:e MsҥW^>{e˖Ug5q41m!`!`Y+=쳾\ٵ,duyd*E!HO}< o8?- -ϖײ ˼вu[F6YYVGuv.9FJW %wYI7*;cA\[V.?mL۰cC`_F`]jglJꐃ|yʀ:ƶA)'ۻVFvԑR#6i┥xSb|>6}wFz6=)7w\9uݎ- H8oYp N:/WcAn|prpvxOPC%Qp+j 0WYt#Exn9t.vCYAzK<vO?/8n ZInݴ2JFF۔c#[o!` 8>
6o2 3x@8Y ^Y\B߮/Sl(bRd/r2VF^˖[Z^Ƥ bOP{wW͛Wn}zx>ٳ3fݹZh]U#mԥڱ!XtlsH-S붾t^᭓^GaJ6$ *eB:~DK歠?<>sz.ה'ƫ)0̾q܃sֹ?\&'uPV>? +{yƟ A&> 0a?fGoyCemڑF8$i Ӵ|L/eqhyM솲2.1z| ɦj
qM̟3fVtg~Sr>νB,xb-V8%5 ۹!`!`g cV;vO^Gw'+wŊ>ɀ :>%। -47s%7VUV5D>' WrL y5^#-E^l
-f;FC^9&{ٲe|r 裏{F\H y^r h" c1ZL @~6)Ǩ\)@} cݺ=xcGVnY+sMݘ[Ҷ|.2' Eq*;0~%s{6 ӿ##̚Iiߵ(ɞ%>2o}%x pKw lj 9 fH%[d١,
on h\o dpuƔ2m; OV 4C̢E}-d|SzgĈ~$fd(:e^n.mڴqgu#+̙3 JtLC+S/1,z8.sp ~ex؇rC!гƵ
#r8V " kv(iHK/g?2IڵkoMÇN:R'YPw8dC[y| =g>Mr_}bƗJ7ud&NZ Ltt[Ք2nf}I5AT/Dг}v{v g^}W*: wT[)gpZWxFg/DlZ\}eS\bC"2Z6YSEB,lD XBV+06v.vM6f!`?e|ǧ.3+l$[Sn՜¥eӾ Y|GP!el<WZC]y:d?O&<ԃ}}C9L!ITᙏ({--Q2ʇb@sB&Ev+ vf,X2Ixbuj{l9wX~AwΰnЃtd_:UΛ`?3?~G =dOFMfsy k8!2(
ss^N
|ak* v۔U2F&I{mnҼ
ʱ C3w tfGo h$YƗCa) &+e-ZM $n)'} 'Y9/#C>&9ּXk=y6C !f#m,d,MYfL^gEj6 "#}lژ},ٺuڹ!`!`_' Jh@_ ߍ@&>;{W'$'/
ȡ[r^Fņ>/cZ9l4lhۺaݻ=B) Vͳ nJzwOKZ6bic&6e"_[_ 7 ϋi;%|w$G7jgS[{F?wqEC[}#DɤI|F ٽ7)eY8I4,?ʡi=k Z ]N/"xO8.:ؼb4izhW ,Zڼpy'}7K&yڵ;3|o Z8O WW Ewlh
C0 C( ~ l,;I:G>}{ǼN {%{
;>uH/s 9
2tl('Y] 4MvΝwяB}I^ C˚!`!`="M, {1DCf/> G%e7k<&Ftgҙ/rExxƋϓCZx.'ЍNK^Ă}Я_?MV3b6dϒ햞=|?csve߾Q{]έܰއ;ylҵ/y&nwo۬iװq[esk70mIc5V
Nҫno;}-ő{aEI&;\#ZR{tl +ZDx On ^s #cM ~!No.
*D&x`O<~[l5r `W;2rs̝>lچQW%,5JP' 8Wdd-,;g_WZ9m.:5ر!`!`!n|(?NO*N6:ďco 8\H_R,XDFYȉO/*Xl
oW++r/f;E:<yvc&{e+B 1{2X_zb;O䪜5{TK'3VۥτxFmA=O%&RS'{2癛
>]ZwD CyI0d4SB6Ld
%Q7X&īq(DVQ v
"稏z7oy|rEOo(#d~Yך6^z|\ژ| uٹ!`!`"/O.{ L`2. ~Ӊ/o}Ҳ:W+ 9AɳjYNf-|<͘1RUrO`"}Pm+Uh#M6m\ȓw^N +%]Xm ZV}r,z}!0T01%/N jJ2Xlj Doذ=ӾĉƇӚ1Zyb-ML!&z-c<ِ ^f)Sܒ%K|AqVL0g e-ԫirœ5.rEx4>Γ'`dž!`!`7M㣑m6>#aER
}ICVtf5 :eZ6O{£d BGg"'t- hy!]I|lNw~,g`#
cڇgYjCΧ1t]o80!PX lrM8=zpQ
4)qq~SQ6,t@4=FCwHO'cZol X9kZB٘MhZw(pyA#kwwjH-lgM; D"Qf-dĎ{2}퓤t&2d&鎓LNNNgڱNNb[VdmJHq)")Hp~,-TOzݺU{^X'_<*Oǎ#8# &{HYȚAp-[T(p>"×/_ {SSSx3o1o_?;?#A|KuGZ|h]~
'
+a^JH؊+Ӕ"J y i2#HI ɭ_ZY˫ 7 NX'Of(bMŒfڵ@X`AX 8F䓬tK?'ϓ% ɰU$OLJkp Gp k Ϝ߃CN)3|͛drK w7L|2=,n7[>7.byf,+g̸?^\V7OVθ-K 5z!p_yNʝwX%m2yɾY~q<6YVe|[ %YzuqO{~w&~V&Hor sRadqn®o#p} :U5K>.` Rر#N & i2 DžhxK~'ɳVyje6~~VQU uGp Gp8R 6mZ~{4; ~ƍa} ;S-恴!듔YJi>y4}Cԍeȓl|3glmY[\"͓y}de"߉Xƿ9!Ly A[ >3]J6 +C8CwS@ÛpXl}uj%e{{{;~G-7Iryt˕/3d[r.X~lU2"Mn:!jɂ' =;e,>c=P FۛW&' !"/^ 5b9
sX\8#8@?<qqcQpGN['3 *k 3cڜ8q" 7|g+O
ʶ- kr0>W%7gm,0 |;יZJE3-:12ؒ66%coG8mVR۰aXq?m8@#tHZ/>Љ!?8D 7"9Qw}7GJyEϾ=oH>O_8f>SAkzp=ΗFֆxbYNXqaxܳ~Y&,O)Xien1<!48f 8mK:9ۜ78ٮZK;+㘒Slj }+k;"pk`qɓ+YT Z~駅|w,x7g9( sf eq;}cy=6lFi# 9>.И |
fyH ҔAVZtS`:?;#8#0wh=Q8hڃxZ3, w'_5o}>O90i`2xJ bG | ^3~4 7 pS|JAJI{~\
YdvLH 28 ;a7'8ܘO<|M8Ӝwn 6m8D C I9&* K
2HDɑ#GB.< ӦM Ns)L $_ΗaR cu':"!zԩS $=T0SyXYnz6.e6jѯFt뎀#8#\O% &6RyGUMoqnX?ٳru<- ? aay!]!CWɹe5zcZ?Tk=ӱE509Jvsƣ}-1mv-jK۱͟Yiu )m)ِ8 נ̖/1V]՜_{@ qoذ!DC!=Pl拃-2{=^˓vc+Wkvi&ٸqc/z^OǟEy|3 o8,'ϓlϓa'O^Ȯ?Ͼr!sh㗑9N fpxӇҜ\WVGZmf)͙ ;iSq: p*G cW% ~aYbEHA~ݻwapRGF^# g&qruͶŲ4ʓvDyp㛕I3v-+D×hmE}y2WdYݼu#8#8 +}ն4|饗B>\0kXvWƺIXZm}˖-`! yI[wOWhI B5O'KI;.ϓy-im 5 6*2{@n}pxAphg3V.| lVn; #\ ٵrl3#04pи,PKrUC! W ͈5dCf_ti_Fib i,ֵ2֯T8-G:+ă! rJ>}zx/Ѭqorue]֢_ne#8#\/݉'(eܹκ4puh'!i ?.C|㶴>Y+VV?'Yҟo;iVkF~+9ݓsJ7=JtV:<* 2/k[ maJ>ooA6V7YG\Fݎ;;̙Ҏ)/3]J G@ C:e}UkiD4ή]B$8dW!|9`PΗfR 昧Ǘ8? 0NovΝo ЭJ a +w,ѯF'mZ n-c9#8# p$HơC4m4x:p8ᷬS>8Ta-vR
Ώ<aͳ
e˖dlC\V_ixz-խFH`vp'7n@ ,L6*9[sd8.c7vL?ӵ:r6J9]G w[$[lٲeɍwڵo7a%QDs=l_ vnavsKʭ_ZYk4&3qXC
Wy c=Fxx
;-o8k}/Yd6N^jeӵQ4 Gp Gࣁ@y`!C7 ܝYp7~CR9%y\˓vccdIWw'aέO:Lڊ!O6X y|\;v؏J'q C@0>Opd#uvs3ninjG=kgȬɩ8 Wl4@ |AC*[h")ﾰQPa/HsN[,3`tiv>!gud֭!RHw"y] M/y͓%-G Ev˙wwl12vnLgv[1M;f~iuls~0p6 Bׇ//vMSC#ͯD\@>qC>!,×9WrLb\lLJ~"# |!o3
D̟??DT+0o̴stb 'ZBlZ ɭ#8# "_< [mFx-ܝ6RМD}'. ss:wk֖ko ͛ιcdžs;Bs9ɲaiim?.Z[{@V[Bε8vV2nMk3Y5e8Y/BΉEX$'<4`X?9^,/,-c3O2k~f#,nQ48#8@ E"=l%eEc` oշY N5d ʬCJ;3pwsxo69$ 蟔Ӗiφ78xC.|oέdYEke癬X~\ q]zcǔ%}(v.%YsKc kp6 B'tZ!]d?6&b<,_\ȟo߾PJ b;D[48+9"yD|37W%W\)V
DtL<4ɹ}d+Ƕ"jEz̻F8Ǐ rcB
i ڵK6l]wӉǍLjtq\$Oֆ.N̏u3 hv+Jxʕ/O7V/ҭE^n9Ud?|HHnv 8^b]++і :s;8)蹺}G_x5:|C/24 BgΜ\:::B$ K!S|Ϟ=!/_sss9g<ٳ! '>;Q/?$rĢ^- E1.crc쪁rEGp GH" % q4P$Wc~Ï4$!NgޘıL7kWsy8;
YҜ0w~|ajRN -Gw qT@7I=v ~ksGs F h/3eȤ !^D:ͶAy->h^8sυ#8_@y9,1pK9be)G7i+>ϓaH V#/ұ9+ / o$u͛[YZ>eY[$zJ>EǶ8#8@0cK_`AH h5䦱^c 59;o,oY`Wbǿ9ARF7ܝߤ=azÛ.IŘ6a ڭ̓W++gH@O^+y̽Hrh" Cs>+G"!te2ˁ6'p zv*
kKS/Jlc˼y @}aٲefPMa,cȏ j" :i)hKnXIy! | 9BFԍ~ G.8Z뺎#8 M> +mF"&Xg%k?Y&%啒XZ豳0zj#qPoڴIXi Kt6sΙ9xNB9_~98!H@H>m6szl2O'mdՋy<<6YyErɱp Gp J0>ce g}Mlًm}Zmh[&74^۷4Rx3'!> qw9zhx yKO|ў,d6qbd=Vɭ#8@9 X !2)$g182:&B9dclpM^?Ңh&[oC=$A6 ib2 ;K~{Eؙ-Y/'V j-ϓ獛̶4{imfrE}̖#8#T ݸ*D27^s
Wc .sJ(
f<N |ޓ'|2<[.nҖIO:; iccǎ`Z!
>!oUt蟢sV^cYwxvD.9!#]҈2q
4ainQMl GOA_TH 6/wrNO ɩޗK#ꤡi7YFS=mKK<Z[ia6-ҵEr#8##0 1dNd3DHĎJ~iEģZfB! NG|8~lj}ɰ$U!6660уCnD@Y (ȳوY=OF"I+tkim.ҵ1(N,˞z8#8D ^ ?8IBj;q-7Yw. ^۩Dgýqpx9n3Ol kmذ!X@8V
ܝ+8wy2aWiYm|/>.gad2e2E&jG27aކdEƴ .̋7C:OJۡrx.9g Nf( DZnώjG'+Gncx8#T;En ED" CHCɣnLz(
-8-9Q3arxCx5H sD }qJ&ȹ
$8zsƘ rsk8#8 ~5Rxqr8[xSw(#jXqLb#,6'
L"䄇 wyNp9|ҤI!x Zb8qO?qH /
de2ei?QFh7ojװDz}aL<],^Qg۽] +fI}ӄ%5 Gp ~]\'gmgJpcbIDEF }Mܲ?mf. _Dy!G8+ h_fMxm6N.\(<@ Ґ-(sEcu 3FCGipG̐977K۱yje[ԇV߶yEȶɽt Gp G?ԅ
wt}#,yyq#ƯvԶNj!7MHχw8^8@'EƧ?knY>y2lSN%+Y{lI's.٠k%]` Μ9o^ݚ
$<)c γԴiSyhܴ&Yzm>6lԍn75 6{j Sz=̑uzpVf瞧o}t Gp< e֖2 1$~GUk?Ϯx0XhQ qDc1O8" 51$ d>)#d;yri6VE6NZY[4;V _\dzYvp Gp>:'8EZ[x8bN`p6
\1j_4Zgٶv ؼ9uTYb]6pwҤڵKp;\3.v,aUa(Mdsӛrh&3mn7ͼΓȩԪcE#8 !АUH3=sicSmԳZHpjgnD$e^ %j=,i9Ӝ5"k1.crMclp q Gp G(B8qv9Ñىm2YGeŚ;}AϽ{SOˎ ;BG^/u_P ӻGaϏ+ P/k̛=^Mڎr\l}J^zXN5hk;-{ _ߩra{߽:
rO,5%ʻJv{"ֿZ]|#8w-dݢG(![( rc7Nx`(TKұS } D&mBjDjŋ kyxz~ {E1-]$ kΛ Gp GoIc
wD-U͆m8I>=yC*CQ8V,V9[yxz~ {I9)ONY&O /7?)i8Uɷ[hM@SO%É1\,Eԏ& 7e:f]}fHٱ ?)7Ȯl09y^/<ܶV 3#EK",M$zEN}GZf-3ƕ-yW$j/o8#QA߲ 3 ٟ_qTk6+tuANmȮVtE$}sPDˬ_><$,Y$Ѷs̚SV{X^d#Knnt>igZS~x#8#8 П " 6~kG8 a= "VoE]w)-N |6[Ecd`S'Ou?#mn]Hn
; ?-on}g^xA tIF ǝ]r~t9WLsKoOFHJrKcHiU/˖Ow Go=#.٦g{.?e6NӢLP45;o(+M3ʈR^F1doQ"yl뎀#8!pCb?.B" ͚:l#,1uH5%pM @`A͚OEs`xl^$ z,Ҥ̣hʹimN^]֢_qkՏ- Gp GVKҼhNj"i 61RpJ8iBضtm+a{ rƷv\H[ت '8rlCzYJ^8wZN"7Br҅.[o??5 8.#Ci5{%COl?. ݥ ÛyqO ti9!E1gAN)]=?!/k S >|d
eؚg 4}:TxYwp Gp@
S*wxҾ!8&ʃ х؞!ľg-CSg\MN;N{ZJʲ vrqn͓Yf2tWI+k5i_Zkѵ{8#8@DJ^w6s07v- ᴳq^f mƍC0Ό34iR VYv5:iWci9gt p Rpuz) >|Xو>/4[ڪ[';vz3? k]I#Gdޓr
aLO":l:Rv >-.\:Oz F {e?Oa7dK2et2l+>eHpr'j03
/ Gp>:O
%^d86r1$ iu4Y;$Fv;'<Ǐ z!;a k6,[H7O'cZ覝g-~ ǎ#8#T om~ x; G/|9 >[';pY \Z_sCm!μƨx СCan)S-wHly'wo+nEW; F|ߕՅ-C =LԶٵ
-֬<%yn̟,cdv=I.{~UN9%1Cp~Rck<:u> =rNO?_-S&[Qeu%Mn9pɓaH~yp/ Gp pxY0]N|_Fj:Nn2w 'Of3 81"1ID eŒEDcǃYg8~ qNc>rMy5Չ:/GFD]z 5}m*W_<.}{T7jŋ![Fc]šv Po;e =5]zz;lߖ'zͺ獚֥9|`^jc7Gp G ; c#6CH4N^ҡ=!Y t]J# i!Pv k _-[~Yzb0[{h%[:x])lĉe
63Ci;p7aq ++mݙOV/9&|خM*KxHX<2'/~Y^
MA?n\s[!/ dKmk}m_=Q>Bǩ vǭ?D|`wY"Gjw{*}}wKv_0G2yCO_~VN +M]W~Q ]8#p RDi%ԉ0Mun2HidA(qvBy]HfO۲l}m\;2 7Wb?K/=]NNN[['[HCC] G3)(old8袠,.6\ȸ Ɖ>۶m _!X-0eYh\Rnf̛*kfYvGp G"/[ps8xqwc=F̾! CN H}Ƥ_r3v;N1Y-eѸN֖f~i{2q, p~ =rD~'Yz;OcQofԩC# Q4ngd 4W(+./fI~p:ï89\:"»tD0zz:4;̞=K>Oh]sL5O-E6{MFj'kY$OcGp G wseYd/T1BqHB9ky l(SLS:v
{D*㈅ ?Hѷ)K,5nE_'|28X`1ފ0V^뎀#8#T <#kU _åp=}
26sl|Ҹ<, # [4 , O-F/,ҭV{Qvoe# Q67 ʓ?zRF*s~#OU`X\zx~X§۫^}SG5'Upm@4yR;E] S MW&ӦM I2sb9vTs˸ً[ vy`q Gp@ UvU! v0%bK/RM;; y6L p#!VE|hi_k\M}v <ҥK8Nc7W/:U9k"^ 5D{s5au~峟lHE2}m ̝k=H! < [^Ry[:5 9^FQuG
tOp;w;S>ɜ9sg9mbU^Ҏ ;#8#@߀noN`eqgx cYI?x e yԱio2^|5d3ﴹUgO #SNy7ᗟL|rkwwִ'.U㜎#/6 j_k +o+uvKp9۩k Na{NbέK#?8O2xεB:"7o*_}SxrBc8iqs˅2eRySc 3{#8#p
k;g3"m&3gwLdێ.u; ]sC!אs Vn,իWbBDS|_ `vkXEsr'DtLHi?ZM/=` ِs='6lF~YA^'j9kwI
W
j{BsL4.:rmO */oܭK: J!dlCLR
&ܩC$}'_җC3<?]ww߄j;2Wf8#8#O Z0n|npy:۱8 m ݍّN ^C0 ~e6K^i{~~_q-] A'ԏ:-Or2RWHW'}[٬|Dh#~[n峂{crC[+קuu% h@:Q'Fߐ__ 9M&ʦuoH}8~;g-#8@>@:. 9Dz/ gJ DBO ] ed:8S.cIB~(siɒc5V^ {g?? wq{'ټlzl}X?zJ ͥW`/*4&7m<.8'iʔtQL"1DO:5\KJ<>"Wl'3JƞG|z2V̘ +OSes{- eʦr|Y$ ! dK "-cGͭU 䮛7,.w_ gg!G I8Nn1Ȓ}p Gp D 4=vx4|@vlvrC p}wNyFsP
N qxxqch,3j7`ttthrn]QF7O1긽 b2}N|I&j
] +$ .
?_zoiH -ԭD6ݤ*a(i+`;RtzyC9s>Gp% 9Pb'6@ #49xOkԷTAn]J z0XH#m'˘ɳJc8# `1 #ՐJ: DxX("7y>)L5%Q% a"K*#GY4~AV0C>b̚ rF^TƋ3Ϯ7:=j aarNGN-{ˏ^{GZ9U7}uُɋKwӜ j 0hc }z{xKn˖- yпo{d4MÕ YWk \8#8 Fy< 8 SN 61] 0792;:嶶RPrtΓ#)l#/95rAN c MW,' !࿗vw99{J-YPoUW ]ԡ bLqX2LrOuvE놫:uns Qz ovwJGt',r٬z2^a A5%qK 6>s`~`po_K%Z)Ə"c7HoT]D6Dwq Gp@o2. 8qx! %"Gf%:};nE fk 'uQ&⛨空@M+xU[3rhJЗ)]+3.9K4zN#vtʞCm1YiGpwhꔿ]Ac'χ
(/6l\l۩H VXl9s ]_|K >%w
P 駟H' d4ː[v9#8#P E|#ivq@w7N┱-g c T'`Ӂ\@T826oe|ڲjٍ֞eg AT_FHcs5Թ F;u\N Դwɱ=oKrQcIø)et9!s z,bGo]ٶm[MEҢO&lsNc)NkP/8dޔ17ˤ&
8 rt56}9JnE/sD %?A3Sdv9tR JNpuhkTx:q1g&.i;&?aM)S>
M-2M#돼VR_
Լ#8#Ї;J_EFX!٥G?!<6szC9&Dc'NG8kNZ\֗z[ZE;v_uYdK#(eVz^hgY&ܺP:?^'~fO"1}dC ۲ of-aqIi<n'-8zŦ9̑4Yך[4xќ n!kv/O%<}\MӜ13W,Ȣ~Li<]|?. ֻc2u ?uU ?o<0C<
hA6YIG}l]x~z4:>-Q|ʷCw0sÖ;5
F} ^8IirY >L#^ucgaޫ/t#/|>Lnh8c47m = ̓ep G wW ֵZ}52igE|YBb;19CJmX WHD ^^ٸWF^Um4w#Co>Ϯ{ncu+}u^9Q5L5i$2AͿIvuɣB~u ~?Ɏ ; ݩncғAqBItv( xH橶J5qAKpњ+>яkU 0G/=k0;砏t ~dW Gp F @I[Zq!ZDw4i;g]k6#F G`ӈ5%}Çhp_@c^ܓ知oKL?K [.D̐ g)95 Ơ7̝(,';nBx Qg]nM{dҸF\Zubyg]OHsKZ*w!$l ۏuvlKGp Gp Ye%ccn;S8c; 7^o< [ܿHـyT%qHl8MI:Ξʐ*pmۺY6nج@8؆ /j%C~M#8OPzrh .cևLT( NjJٗ\
^Tc'W^CBe-uJ*c~8# P)Ħ$m%LE4I:%qS a
7#HC݈5mRN~}ɑ#GB<8 :yf2m˓,Mͤ?Y`t髕v^iZ!}|by3+ylrFSrկ<<_|~T!98';eb6" 6 7F1Ns! 1ii5t,Ŝ3ip->L\ 4Ln}cଦ7$ǏaFO Dtp GBsg!3ڳȀM"츒6$HDz@-?KJ:4a avQ7#|pj% "ϸOH.Ӧ)P\s^>>-zɰ_$/wp Gp>qmv8Qpl;<ۢy9Wv8sJxvbZpni%ܝ(t`"ls 7F9~p糖vLLfΕSd5[Oyu$;,o#eTthZA ^6MtXd!OU 9 6̱_vrCzL,vl Yr+E=?v Gp@os# fĘ6[u R96g%ȠIaШ/PذenJ\<üW\w脜s+Y FH
XS'4sO{~`
8/o#O}xbd46\Gm#8@#~:FЬ@Ҷq,OV f DuAd$ g5"mN {c6;P)' {؝0aB_Ċ˚sQOV"y .pŀ
7 in=֭N35W邔;; u"}nSg;u;eѬIrͭruQ{䔞oѼJNvOX损/O"y.s Gp GHrYel;Dz %ްMN86hB pvsdSn%u `a
ó kE9-X[.a7ꛨ7NXw3|ٹu:uڊL9[f f̕S\6ݾe٦a}}X!/.ES S/ /tyޘ[ 8v. kKYxsrK|ltS:}rJ>ܹ3/gҨI??6_v]xRE Gp 4jƥYPYY"PX\H dRK %
BMd NkvFщ_v# fFyesܸqPC*"(ȓ.< ȩvBrES5uHluX:t>X3B#8v 8&/l͐;̖'Y~,- כ{ym}d) / Gp G(jxirJ嬳b,lfCF 6lȆC6Ȭ/2P&y87T*' v3]$_Vd;
&{WY9~BF7w*ן(3 ofJ]"mt } ʢR7^d2lF?d4ևHpMVq_Ol u )mN}2 iVz.b:= 35\{TSJ̼G +}n5oVVf Gp GH"I_qrv 26:k ,; ` [ig&5xќcn}r]=iZ\ gd;{?3Һx;{RS& Uyo;AMms~_!q.}AO/s&/̾. Q?7 *ΟL}K?OȠ~?7>VlqT|'_OݫgÌƇw앁A kZˣ??m.d#Ĝ,D&d1}hs< %bюvLf(J6lJ[|p~slDcԺ0i2^FɱSdLYxKIym^Y`8s0{T>eF 9<ޱ'*٪f':#8Gj9I:m>o6;vVܴwN}hǦ͍ 9}a
JeN5zVZq´tt,(yYҫ @ :rD?є %i|!-z]Kfvۉg5Ht](ݚ.%B"'jڔi FHF_Pu u@yRǻpBZӓ6 f:yF7/'NJc-Ղ@|
ٴ6+ʬvTi[f?>fN1}mI٩n ]eaa~NJo FoFIe~>Al_YlGC_8#<;؞576q=E Z !
ԤK$ D}ڑܜi|-v7[NYdy2ʙdA ҍp 2p o?ؒ/}0},4S!.>s|dFrC m]O g˲yd;tGgpǶQIc#Xy<ErKGp Gp'8Sw4Lrws~g;<]?0:]]W ) q^j?uٹAd 1~_6gL4# )wU l>Z>47 px<>Q>u,9yKfMP~;(i}ڸY0YRev.6uiK 6]'+zFj7`|^igx'd魿[O m"{ ]4 長/u;{t},{.P\'k ;o=B4+>Fql_;͛T~8ԶOzwYu}Ct+ w_sȳL~y${^i 9n9!DyCOkonQќEX ;±(F/PR. y&m&1O%/LmV:O☨-cԡ~Ij^SgCwe|s4{,3U -OPB|Iy݃aő ,|W1|pr_2ou\pndwRBL3ٙ;%. u \1Y;˖/ҹn^l{ԧW3{U[ WZSG^3>
[ޏӕ?efL ݥQoBl݀:{.$
#X h:|P&yA ۛ=]s$x46j7O_/nӃ F8
ݍ1[TN}鼩Cѩ h!VOW7Вug+om83) .>eņ4->m(51P!TNy( Q {e^/t9uL
05`jG6#/Ǘ{ z2
@ UPh+mw9Ww4~G]ٞmVݖ F取 4YnQ8ҏh y Vq2A2k ( 'u%a ߞÛ|㜃jgv%1KT %S&=rZqDQz&~W;Wk^}t?sK|%_a{/\8BJ73]_ h@)c@?"y^ Or : y|y돀?XwII G${ms/%[1={`A#A0*
+ȏ
MGx(5?5O~a>6$LLJf -_ҶTZQ#V`|_6/{455^3JSbZs)77Wh: aǫ IQːU.9 #m1g-S X$H#UƔ#*٥4 A`*nض'ت uǷL\S]UOA kme;#eOl,R΄3d71pW͎0Qzkguw03\{-e yhGŗn 4g{;^^t']w:Hij)ky56 ~%ZG?->mH_&NgK羼YÃb7ҝOltSuTוKu?UŋYP/^& `~lʱu |} |- )n +2 TQ: QRѰjTLuc07}%"^m!!! 2yKcz;OGՇqJ^/x(!!Ax;w<c4л~ڜA+1oo)4iH hatYh^tʨժm4%I 2aK6` ۋ*6ڲdRrl(4,Ex7vH˩ ߖ-`B? epo{b55`jԀS
ЎiDtT&p4)GvxjK }?8[6siv 駳_#`n Б# #egҮ2Jey Ӎzl9r< p@ˊjE\.( 36_@HX\#2xk5 { QGe
:s|u[)vcuǎ^)g;<9{4t! -`p X*@]O\ b YW(9`
OBgmrjoΔmk\k]pd>Ҟm Ĝ1-`R Q=d:ٱ3J1q|мXF Z- ;&=zm Б'ӊ2vځR@@xdh:O ju
2k ÂEJ<oƳL5f^P'^:zk H{i*u}nڳ<:X# p%G~lYL6I4)[K M3G_r~z7$ y=٣,Ds+S w1 ^Jrĺ^ Sbғao%k\vw9O"M?Z4;jmڻBx~XѨHY걤J2ZC"E]~}=c#ݺ@N!__Ƀe|LD8>G8 O)'Ӱh,G0K 6Yf} $?@3| [M Uހqv4s[s f nÐF
13FΦy? K z {O6tN;' GvE
0i@
]3:6~`@ wkخdʼn&>Q fh '#
^N
W at"-m~I-1xonо8D-קj7c!hf 19[1 L n/ F *g:XYq9[Wϑ?ޒ\#x>NbX\3j=|9Pt=RFf Q{Myh 'l^ni]hY{ݥ6^uơ' >OHД܋D6 iN&.f5 p&
ҋ> z :?h.;U~;v&yyz].|CEFZa;t⍿ xC4 XG K:ۻG{!; *>Za(88t dY[f cLߟyCL [.oܶ&%
a[ΔFO !
7 i͒D`\{c[eթUj }0X_^
>VqƢxo̶i=uIm6Oip.kx¢Ɋ+ܥ-{6zC3-4F;pD{jwN
6Uڢ7'ʧ ?W 5П#[Ǟ
mo~R.]qa>vMv`KR> ɵUce^$G#
hED=p f8J 3;6aBnnp{ *)hpb{r KnW+WR K!Q2v1ńwz5az ԦX_@ +{u T*qoIk mo m##z wrF'?}b/5u
1`-aM r_BIc` |*ɴ ]k!xOj ~2־.xe#x3ߢ:d?UYfOQf1/=/_}Ns9?3uW6mӃ]ȞgDž,TSc̩YLGW& ~to1:8?wn AZN\H&D;+Wn*e - ?8h5Z9xzif22298hC /#oGSm\5w00mZ?9>[UX""; N0ݎ50/;A7Wz*0~!?U xSsS 9>4o
TXX( $ ܝNvlz k~k!-5M n->OCzOY/ڝJ+[_LIC2Grܭ7S9-/#U@0$D61 ?a2 pxprРZA[Ѓ *P?2K*A;^0و[jׁzv| i2Bx
GO{vb95Z 1""#d/jg*jsӿHjL ,
45 [ G H*
粬V"n 8JLB8 )\WZqt^L#"I:S,s[g v>2.12.zЍL r =Z" p:9m_o[)+@YbTM|z^&p}2K|D,^l}p m\A^~WCcN 4Ak-{vW'Yz).tt5`GWvG7Q[ܹvlgv C8PcSRR"ăeq3v߶n۞sx|4"$lh%^ ,S&dudXJ, Yy^V]KuQ
1m^ !Пz`31|iiILLߑջZg
qo͓AJ`Co]̚]Qb >E櫻_"ymzj}[⧫w{\]quu]RLL
0A{*H3(R!j=dG.v p Qޝdk^ձiyg]Sa%1('< KR F b8h\Gh!.
F[sQy1 c+(-z;?l pf`s, 8/ |S7/w$/~P eM
T/N gq^Hj
H(?I8J첼sfs |A#Ap Us9z 'w6#z Y
`O,~.&#aNl{jkFxoG1 F*Zgj-8SLXnp{y:zZ6ĥhF0" MD ̓N:
㌾[`L
8liLit7鈔i4y.Go}Eᆌen{r6(*$Ο|~.3ؖE鹛몆
fAƀ.+@@_24o cǼ2yh oH9 ,^;̑SFЀq": 0Xf :m\Q+z #L[.aX"5T쵴߸~g:̧WF&RxP,i.ۺH ^
;!*$'>"sH|x a"ّJ[ }?M_g
p}uyCzMFտ<( gQDPl1#j5ݣCthCA | ߥ;2 Hkv}#80o ;Kwt8)2
NI0=5` z(R)"EݣQآ-9lvE[#%{.z65I`O V˟7&w'kbQ G?dҐH9vL~%ln~J^,l{GIvm3ҺᲃE7X'iOs^`6ׂe0ӹoPE{ }!
;fePzFgچ*;5UM9LGW& ~t~h7&YmɕF4nMŏ
>0]11јFe q9X}<`߱cr= DŽ 5Dml^ضw97
{)IXA~Cx8ݟeg0XUJ#SWL(o^Gn#'2M}VН G˗L{: :txa7nguWa շs*fcDمoi1먐$DʷrEv5[8x= ,' ;^̭LWo]KNj}y( 7nHw>]f8I |ݞ4o@g}m]xFKgxO8/~18[/YFo|ĜvM)=% Y W3%{ˏǮB.76Ջ-CPџMڐL>t MxӨ"ߢkQ/:L~, rWZw ,6
~%{/.<^W
Qo.(_sN ]Sz5;t `Wzd=jLբ<94_}.:zC.-e /T)A a!s;"z\G6DZdcm%e!08vǧZΡ##=2lryTy{ ?yC DEPYE
:5Pf+$DV w2ĩnA[>vvjt S$R Fo
`CE(7BpdOsP-)-Hbm<
AfO= zB
%w5 ܋GN ch
'?m_* ?,by}$y~nfZ樊S)YWoFm-O*;Z97iMgYAG=qqN- |j^1TpھT3 آ|t5ѸZ
ۥ
Kl7ȄDeS^Q% /h`c."6n*V5<˽Z7IjB溞b
*((g:T}2Nr xj )dBtwYe ͯL )oU
xê O{?< VQ#
vѭL _s dv&j@u9:\|KPn
~ݏ[>"xXUe;#wawawx`Q'b/nhZstx(*l4=g8Z X]?k^a3 &^>rm:hz=}ۛr{W1?%]*>WپhೃߎteG0H4p)谳AkYM\ veސ~-
lw}BÙ2GsvT1.۫ ˟=ePUY)F $6d ٗC Ye<'X =
ue?d*tOZh">-juh`x?{^ om̃SA
p3! yLRTv= 5<9P\
߿"*$=x'{yS=TԹ7έ= X[} 9"A?A]~>ط>@C9tijnGO{й" ȏV>+G= v w$T J
"c-@~ S\n;9XtcƔ ;}N;L XܲV.K YEwmLIݴ2[?ܯHs_O?nP/o=jK8P<_OdKOy d/%1owՓ^[X& n7ig+7rGmɔ?
^%0aHgZu{s߸q# @oyా 3yFm=mOR@oиAQ sW__:)y
HbڟY_.jdm f &-ShÆ
"f̘1"24 mյ,850m2P :Al
k jͼq[ #xܰVb'9%ٯ/bz貏ʢdJ* $Gm&_=mh 潅=Y>gw2 8ԛmڻBxXHY 5;5~w)̣5"!Q?iᬧu%[㙖D)}iU/ST&J;\v3@/)R, ?S\7'ڨ|xsenOjJE!s(+ީ>iTTI{ʗ(~ =g?gty;g[vɺ*x8b&pFm0[&ˣ=j#y=,/Σ(ٿ 4ixZaZ|#ChtD
;b
֍Yv~N^Syr3N t~P-k5L->7,ꁇ ٳsDLǖ;j?L yP[u
F5\ί=e +sNg3\]@34y*ie :K[)6<'K_ߡ7 o=vŗ|ݥ@S' 8 ;d_y6맬QWzaXَ®}1-æ$ :P E;% k/% @t ?y
%ļM0%6g7ղ3 i Qv ?a<|?4s^\E{oM \V{>W*)wf/I k]om|ba[DpWjfsAu 70
5;ACi yH
R#zA8I`Ue (2&M&Prl(o)//RSSO>bˬs=}zYLFe<.es aGq֝itږxZr&N_w!;z{xU˄ :x @
.T(+qD "=*" wҀ1:6q#-W2@MU"ු`j\(ە^|E /F.f%T 3fkiU( X/:.ζg=<XA xoEp.yO$;ֺ=FaCL
Xk {/fF,[
s⟥E44 ly읩QR *0X8FeF?IYsGh E3IM7&!lwOoqցe}6"sCp3+QrzcY-Z80<-J :׳r!-~ܚOY5r_Asusi'~=Zjε&̥eC̘2Oo?қ&N7<»*J /z2*+ 2\\=7 x# z (:_ z+V2;ur,ɻ)~mv3 ѭ ̈sTS݂]x_wvyoP`}33"ƍFOvq%?i ĶP_2xWM6my8̞xhg+=b$_XO$40g}NUgĽLGKGk`sܶ7϶5Z
Jjc &|WlK*V[RoApG k\/FM2l a ?_
7M ٝTB}mm3FC֞, noHϡ {`'
KY{}e cN-ObA_oO9&B闟W4rHi=7W띹cǷ 侳ADz4'"x:rwAv \GOk;@rW8U]i 324j<' *ؓ_|rwErŻHUՖl t7nF+sxL
p~xF?27FR y0 FE(3L[mlK۫W^~AT?s)>u_ FdYgE/[E|z"f#D=?85Йj 8zsroz)?`k28
2m I9Ým-*
ӎl$ hf: 8vJPp M2uT`9?x3
뀅Ig'`z;sy{j[3k#ʤ3 kUu W5lƙsg88&ʽx7a=o s@8 wP~
T( F颓8FwPYu3B خ {SKGx7a~Kv%Plq.3\%J\ܸ?a% | ~WH<> o(1-9x kt˹ #(Sb|&` ¹+fqS+ ĉOiL CٖYv$W Uo\-G =z4-[6oL0=c)-o9 ?Peo
V YŁ*8o *-]+8s_n8DCc>i]~Wخ /p ߎmIQ 91 ~Ab !C(00P }Cζ'df{
6Tc 0HwrPDxOwV!8(i` 7_^g2|We |{I?&:e/sv>dj7MG" ɕ9{^*- 4jB4{d/Q{2\/e@GM5X]Ai*NPXx&٣.pQnA~z
)Ȭ8a4` EqqdrO;mK FFeFk7jg?K* @ IDATTUo\k+ߓ_lz ҟ^j 8ڏ;i>ZϞPSƠ/WK v9jGeZzw@8J$
$Y(g$ƫyN2s{!Kh!&Ջw{6dIh晖j%ib{x2
kTP.2p
@R2y\#8<Ώ$9/6R/(s[_٦3)ƍ@@Il_>E %lDeaɲʥ'l.I|ڛ} O AؙvfY[
x[%Yƍޝ^g _Р: OznuVs CkvϛĆP-ӹ+ouXk` zm$F1D߾/fTyE "{rG+WR5kǷ wյv4i `=oA #St p`C =LO玿B. qi[-d `K '`hToP |B~c_ 7bY iD+&鞜
b䃁KBD?19T_h.w>Ȝ/Xt=RKsxt&Sm{ngx0Aq26l>
=n>ֵͱbwZݹΎ OӀ"
w/Qpx ]xyvv*d;=4V
Z}ʼnƭUl@(pN ؚI
e=Ay.mp1a T)2I
k HO=E8v
TCy8W
pj K5`sY% ,ub_B]+<ьcj4wI/"s̴a<~[aw xcLG_& ~>3wwּ!HQ Uo]/^zΝ;itܵ! ?QmwGz1ثWg4uG=|(;=#NeGigM'-]}dK{8=B%
8'H DZ@L@,G9g69K|D9F p?q.e`=&Қ5&/qRoAX[ߙ{ϟ}@ &r~XJ^̺ 70Z#1I(M қb#7ylcOp/ݻwO?D4bb om%g-ؒ굶%,?~4O ͞p]||u
TU[j+ۭKxߛ3I
//wqTYtmjn~iZi/%hr{z5xWnT?Gfc/8 ?@ [wj7NNG _
D'Wd] zټ#k."Ź >g l\("C zy<
g=%^6 kN] lZsLbT %O87ON<
0rt&]?(Komi;ʶ=ړ)+Sm/e vɳ.kLLw9?&nLU$P/+Gғ a+ Y\#u2'8F Z0/@o,;9 G s `'B=i|Fn,f0GDќϣ[w51@Zw)_s
?; P|.Fz(_W=f6];\/r;*a-6,':d6!8_a%ި,35Щ>u갦pW5 o[ ڪuF{Wcudy1j^֫Gw!kر{iϞt>b$(6SrXTYEٛ;/[!4yx
{{&/@z2ɞi}wIc$= `㘃1Gyxp MԋқDPۀ:BUyj^mcOL
¿^:c4`Y=Y (Ȣޠ% 3 A ݺ鷝/sE Zm xL #g\2 yۻQ8
1WE>9ͯ&J7.ޣץ/i>u7CHKhc |d^̋7nhR V3 e?!vn\K+-9Y =WCCc.S]?^VEBUu;9ͽ/&Mt/hõ[[YFY{vPe=Kan$ПhyjZ 0 -"Ci@y #Gul 6\'F ` )'r3i y+jGԳw4`h.
.]li7h 矙c4
,
ZڙO4uXo-4axz $@jXo'<93L%% IuG3eغU. c[g S7p0?@03y|3"e 8gB=Xˌuo
{q 4N /
CgNvõ7ϮApg$=4)F"4C`~iux7}m9k5g<&<3r73f)Z Ak
:wA/ o/~
J;(33'#}:w4}7Jʭn*]҆wi{T֠E6,>(yrV Ks, /<
21r^O[RUQƶMT/wO~ uKbhΪyQ8G^ > )zqDGqL
R/P 3cM:^Pm=#V H uT 0Zt)
9W״;` t6`w<٘ޑhד=*15ɳ7 ;Kh өiO|8xD:}L?6bjә'fO裏G }Dz*]z -ӹ:un*G_?U"Udd$]}hGlkK Jg=I&7ԉyleС}a1"B:x|CvPJ\V]H< @k + ؞/o *> 0*lJ|up (!'18bqU[`{2P#t#B8{3R2 p"NХ}G1V/rdžg>ӻݤʨ +,,ԉ.Xbbb"y^ЅcQ3(`#] xfBt$f? blɰUoj4yƹkpʺ#M
[|
9>OS}
5Ԗ9fs/B`_k%85Z;!zBO{qHB(ME~l`kOvxce^˷p| \"o
'GK0 G nQXC0/|
{Y[]A6MkWSC@ A.'~O8vZ_o`%'lTm l/8VD3Ԧۨ7c(Ɖ$ _!///PPBA)1*r ˄=89||rAԩ%V2 0Bh>5ZˀYQ}s[ mUW3Ns⟥"l<75 4ۀmzzd]q
!NQ$Lu
8SZGcގƴWO@~1hLOx=xW ?_/ uأL ' @8 \z0 P M= su<$<)(ć}" uw
'mV
XIcFP
\&\{оja{ղ3̬Cꖛ,G[7QbI|߹L,ku{i@~#\zwYwl:{)*-ϥxnjfJ15`j+4`]e'ǐ7UG7v1'9Qo{~~Fr)sFX&MD|
; NW[ & ܚO~$@_wwHâ;_]<<5k_%96.>Bi<{Һk믿Cg͑#(//OxSaWDAA(@Q(11QMW_kެ]˪^C 6mx@Y{xFymSK' ,IT Klk2y1 xx/&Ҳ#
`aH
l
N_6>1A4y@ENCr~SOǟzEMU #ga*qĜlg E̥eN\wt=d;y5Kkǣ?#s橂eCO\H6hۨ)^. ۺzn:p }K?f̘AcdXJ,mNeΰV#Pq'Ӎ>b^bӆ'iST}q>C_\}g$n<~k)F>coz8o@? ڽ{7ڵKp-))`7x
$A}}vڻw/}駢 hg/{=6˨\Fyۄi*u0ʟZ ͜SZ5;qpw܄nsrL
pdj; Mvl{cZޝ-Sn ߏoXK~2x4u>D A zm'TR#A PS}C-&IioV =f*mchd
fzZ92-s~@>+,# |,7ȗ}
XÞ D!Ks4G+boi4n`~g%\"DAi˚h"Zz=L'8f X$ g99* ^vQQ '66z۶mt-ܹRSSWԎܹVSD41z3?b&fz9E)njU/AB3@<jZ{sׯ/o!+6<#D
iSntuL:~ĎG: vwՑu4O [ h Ƈ0ɤQI-(5*pEų~U# x;B唾y
ں}ڃ zН`ߖ[#;ܠ#Cr5
,yDֹ6J葉y WːpM}ۤF,n&S׀ ;cMh!F7jgAQ_1ck5?餓x~~>!)5)d:gc'@7ϙH' 駟jYBÆ
zH (=)5!>k .w l̹r8FCN L1ud䒟錣^}(=ߥWnx0 (Y`t8ߟi"8d#e4 0簬>?찝u
$3pg /N #50g(){jZwOD;j;{lpG}P~Rrf},\aϨb0nM+
-Piμkwr
ƛMTɈuOoj] *+B " &=٣wb6Q-
FeRܦK+멎Uz ވ`_'' ړsh*J?\hQt7YgK=3ю-;zxҝooك= y1JبY~
v{ ?=]n91in&S4&HY
&kF]U{s]#ʵS[c*W6 .ppc/Xౝگ?͛1 26 5 u, i$:s @/(uӈ#\ZYC F|.F\~gG] M x6?ZM ŏ6nu3
x7 ^ d Κ#Fk^ dS/zit GG!o8 Vpl_rH $ 8F w-XWnK,fj6wϧ xh Tׇ _L9E~5 mݛ' v8K)C)w=S$,,dzJ:5w 53һQòShN 305`j@k =liadO ٝzG}V߰e}/KϜܖQ};BL?\KyE R#Ö|D
%LQ~X\^H1Hq5iJoKEy-USMC#Eј(&ZTSNI=5p`OYo M
K>E݃Yˋ|H{n;^6[_"&g@{zK%xP qFt0]T _g1=5*r^ Z`?,{p^4SWу]H5sEy eE g< H)7܄$H>i҄"OC}ʳ!_9f/dmO M*W0nQrͧ#[m u<0:}K A 'yiCg7OuƅD 8+>*E˭f}
s}agb
8P>hNN;M& xxEqk@lf p987_gӨ'?ݻСCeȑ6 yǎ k^FEL+iٰqylQKnZDT
[{d1sT^^D{fnok6ߺe l"ׇ4/ 'Gme
Ѓʏcyg9QGɠA8l9/sprGu8Xø@@ j_4 sg1tΪk/50wd1_~qٰnpn[mlaܢJ=H89ǍL~EgÓ[LCoo0)O6\&ɠߞB fnF/\m['6I;ɌlRb&jYEV"k7n3/l!=L@ ȩ ?M?Hi]>
IUV/["o|MDլeyosmc~iI; + @!G'D}߯0{8.g{9v>26mg]u-~K.`-| mޛ}.r~(/߽Q u~3i&e=cq/xXnrũuO7Lnst%49 d}Bq,xJ}s$seQ|SO=eH}M?qϝOȺƐab4N 3P.k>F.< 5j}Vc"@9KךDQ4C'/aS0`qԷ4 ƞ#/2` D}Wni 6 nۙ|[m7xCN[dyҦM͍ ;6J¤yD{x5'
٥k&ɿ :*
F>NȋYIlq~+?O2??@iދGSt"<J@`w@Ә{
o8//2\~bW$ӓ Ⱦ #yZUwǜ, ryg^ޓ6v(e [dʼbbg9Ae&&F1 avHLsؾO&c;F?AZnM93EKV--,nu c1XǷ`J #8[ [n[ Na5Ǐ4=oKVͳ={u5F?بqew'MJhYvHcuW۽I V D^ wL*WN^^?|FSMs]sKeIAڕ_榛f
$8/'ɡO3r[R]<
ct}