From aaf5af759136336b37355bc4bd9ce17ae87346c2 Mon Sep 17 00:00:00 2001 From: Ian Barwick Date: Wed, 13 Sep 2017 00:47:28 +0900 Subject: [PATCH] Initial configuration stuff --- doc/configuration-file-settings.sgml | 26 ++++++++++++++++ doc/configuration-file.sgml | 42 ++++++++++++++++++++++++++ doc/configuration.sgml | 7 +++++ doc/filelist.sgml | 3 ++ doc/install-requirements.sgml | 2 +- doc/legal.sgml | 45 ++++------------------------ doc/repmgr.sgml | 9 ++++-- 7 files changed, 91 insertions(+), 43 deletions(-) create mode 100644 doc/configuration-file-settings.sgml create mode 100644 doc/configuration-file.sgml create mode 100644 doc/configuration.sgml diff --git a/doc/configuration-file-settings.sgml b/doc/configuration-file-settings.sgml new file mode 100644 index 00000000..bf0ddafa --- /dev/null +++ b/doc/configuration-file-settings.sgml @@ -0,0 +1,26 @@ + + Configuration file settings + + + + + For a full list of annotated configuration items, see the file + repmgr.conf.sample. + + + + + The following parameters in the configuration file can be overridden with +command line options: + + + `-L/--log-level` overrides `log_level` in repmgr.conf + + + `-b/--pg_bindir` overrides `pg_bindir` in repmgr.conf + + + + + + diff --git a/doc/configuration-file.sgml b/doc/configuration-file.sgml new file mode 100644 index 00000000..cc0dc2d9 --- /dev/null +++ b/doc/configuration-file.sgml @@ -0,0 +1,42 @@ + + Configuration file location + + `repmgr` and `repmgrd` use a common configuration file, by default called + `repmgr.conf` (although any name can be used if explicitly specified). + `repmgr.conf` must contain a number of required parameters, including + the database connection string for the local node and the location + of its data directory; other values will be inferred from defaults if + not explicitly supplied. See section `configuration file parameters` + for more details. + + + + The configuration file will be searched for in the following locations: + + + a configuration file specified by the `-f/--config-file` command line option + + + a location specified by the package maintainer (if `repmgr` was installed + from a package and the package maintainer has specified the configuration + file location) + + + `repmgr.conf` in the local directory + + + `/etc/repmgr.conf` + + + the directory reported by `pg_config --sysconfdir` + + + + + + Note that if a file is explicitly specified with `-f/--config-file`, an error will + be raised if it is not found or not readable and no attempt will be made to check + default locations; this is to prevent `repmgr` unexpectedly reading the wrong file. + + + diff --git a/doc/configuration.sgml b/doc/configuration.sgml new file mode 100644 index 00000000..5ee77f07 --- /dev/null +++ b/doc/configuration.sgml @@ -0,0 +1,7 @@ + + repmgr configuration + + &configuration-file; + &configuration-file-settings; + + diff --git a/doc/filelist.sgml b/doc/filelist.sgml index 4f596da2..542643b1 100644 --- a/doc/filelist.sgml +++ b/doc/filelist.sgml @@ -35,4 +35,7 @@ + + + diff --git a/doc/install-requirements.sgml b/doc/install-requirements.sgml index f7829fb3..d9cd6191 100644 --- a/doc/install-requirements.sgml +++ b/doc/install-requirements.sgml @@ -1,4 +1,4 @@ - + Requirements for installing repmgr repmgr is developed and tested on Linux and OS X, but should work on any diff --git a/doc/legal.sgml b/doc/legal.sgml index 6ab86da6..6672a34a 100644 --- a/doc/legal.sgml +++ b/doc/legal.sgml @@ -1,53 +1,18 @@ -2016 +2017 - 1996-2016 - The PostgreSQL Global Development Group + 2010-2017 + 2ndQuadrant, Ltd. Legal Notice - Postgres BDR is Copyright © 2013-2016 - by the PostgreSQL Global Development Group. - - - - PostgreSQL is Copyright © 1996-2016 - by the PostgreSQL Global Development Group. - - - - Postgres95 is Copyright © 1994-5 - by the Regents of the University of California. - - - - Permission to use, copy, modify, and distribute this software and - its documentation for any purpose, without fee, and without a - written agreement is hereby granted, provided that the above - copyright notice and this paragraph and the following two paragraphs - appear in all copies. - - - - IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY - PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL - DAMAGES, INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF THIS - SOFTWARE AND ITS DOCUMENTATION, EVEN IF THE UNIVERSITY OF CALIFORNIA - HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - - - - THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES, - INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF - MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE - PROVIDED HEREUNDER IS ON AN AS-IS BASIS, AND THE UNIVERSITY OF - CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT, - UPDATES, ENHANCEMENTS, OR MODIFICATIONS. + repmgr is Copyright © 2010-2017 + by 2ndQuadrant, Ltd. diff --git a/doc/repmgr.sgml b/doc/repmgr.sgml index e42a878a..4309e3a9 100644 --- a/doc/repmgr.sgml +++ b/doc/repmgr.sgml @@ -65,8 +65,13 @@ &overview; &install; + + + repmgr administration manual + + &configuration; + + &appendix-signatures; - - ]]>