dprevot/patroni
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

* debian/README.Debian: New file.

Browse source
This commit is contained in:
Michael Banck 2019-01-15 16:10:15 +01:00
parent fd3cdc0bd3
commit 85dc05c201
2 changed files with 55 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

53
debian/README.Debian vendored Normal file
View file

@ -0,0 +1,53 @@
patroni for Debian
------------------
The Debian patroni package has been adjusted in order to interoperate with
Debian's postgresql-common (pg-common) framework for the administration of
PostgreSQL instances. A particular pg-common instance (or cluster) is
identified by the PostgreSQL major version (e.g. 10) and the cluster name
(e.g. `main' as the dafault cluster), i.e. 10/main or 10-main.
Automatic Patroni configuration generation
------------------------------------------
The Debian patroni package provides the pg_createconfig_patroni program that
allows to create a Patroni configuration for the desired Debian pg-common
cluster, e.g. /etc/patroni/10-main for the `10/main' or `10-main' cluster.
The configuration is assembled from the /etc/patroni/dcs.yml fragment for the
DCS configuration (see below) and a generic /etc/patroni/config.yml.in. The
cluster-specific variables are substituted from config.yml.in into the specific
instance configuration file.
Distributed Consensus Store (DCS)
---------------------------------
A DCS needs to be configured and this is out-of-scope for the patroni package.
The DCS-specific parts of the Patroni configuration can be configured in
/etc/patroni/dcs.yml and will get integrated by pg_createconfig_patroni.
Patroni service
---------------
Similar to the postgresql@ service, a patroni@ service unit is provided that
allows the administration of an arbitrary pg-common cluster without having to
define a systemd unit for each cluster, e.g.:
# systemctl start patroni@10-main
Due to systemd limitations, the cluster definition has to be provided with a `-'
not a `/' between version and cluster name.
Cluster Bootstrap
-----------------
After Patroni is started on a node for a particular cluster, it tried to acquire
the leader lock in the DCS. If it can aquire the lock, it will be the master of
the cluster and bootstrap the instance. The pg_createconfig_patroni-generated
configuration defines a custom bootstrap via the pg_createcluster_patroni
script, which is a shell wrapper around the usual pg_createcluster utility.
The standby nodes cannot be bootstrapped this way, as the cluster id is
unique and Patroni expects a single cluster id among all members. To this end,
the pg_clonecluster_patroni shell script is provided, which sets up a cluster
and then clones from the master node via pg_basebackup.

3
debian/changelog vendored
View file

@ -1,6 +1,7 @@
patroni (1.5.3-3) UNRELEASED; urgency=medium
*
[ Michael Banck ]
* debian/README.Debian: New file.
-- Debian PostgreSQL Maintainers <team+postgresql@tracker.debian.org> Mon, 14 Jan 2019 22:29:11 +0100