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

* debian/design.md: Capitalize Patroni.

Browse source
This commit is contained in:
Michael Banck 2018-10-22 18:23:05 +02:00
parent 56e243eacd
commit 0225eb54cd
1 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
debian/design.md vendored
View file

@ -1,4 +1,4 @@
Integrating patroni with Debian
Integrating Patroni with Debian
===============================
Introduction
@ -34,11 +34,11 @@ in `/var/run/postgresql/`.
Patroni configuration
---------------------
The patroni configuration is in YAML format. Different patroni instances or
The Patroni configuration is in YAML format. Different Patroni instances or
installations are identified by the `scope` configuration option, which mostly
maps to an instance name.
As patroni is usually started via Docker or another container runtime, there is
As Patroni is usually started via Docker or another container runtime, there is
no opinioated default file system layout or even configuratin file location.
It would be desirable to create/maintain a Patroni configuration for each
@ -46,7 +46,7 @@ pg-common instance as `/etc/patroni/%v-%c.yml`, i.e. e.g.
`/etc/patroni/10-main.yml`. Another possibility would be to prefix the
configuration file name with `patroni-`.
Automatic generation of patroni configuration
Automatic generation of Patroni configuration
---------------------------------------------
Currently, the pg-common instance specific configuration file
@ -96,7 +96,7 @@ Initialization of the first and standby instances
Patroni by default runs `initdb` on the data directory during bootrap while
pg-common provides the `pg_createcluster` command for this purpose.
It is possible to tell patroni to run an external bootstrap command which is
It is possible to tell Patroni to run an external bootstrap command which is
passed the `--scope` and `--datadir` command-line options. This makes it
possible to have a small wrapper script like the following that runs
`pg_createcluster` instead:
@ -128,7 +128,7 @@ pg_createcluster $VERSION $CLUSTER
exit $?
```
This requires the following in the patroni YAML configuratio:
This requires the following in the Patroni YAML configuratio:
```
bootstrap:
@ -193,7 +193,7 @@ Those two scripts could be shipped in the `patroni` Debian package as e.g.
Systemd services
----------------
The patroni daemon/agent needs to be started for each configuration file in
The Patroni daemon/agent needs to be started for each configuration file in
`/etc/patroni`, i.e. a systemd service unit is required for each. This can be
facilitated via the `patroni@.service` that acts as a wild card and could have
the following pg-common specific content:
@ -206,7 +206,7 @@ ConditionPathExists=/etc/patroni/%i.yml
ExecStart=/usr/bin/patroni /etc/patroni/%i.yml
```
This makes it possible to e.g. start patroni for the '10/main' instance with
This makes it possible to e.g. start Patroni for the '10/main' instance with
`systemctl start patroni@10/main`.
DCS setup