docs: improve event notification documentation

This commit is contained in:
Ian Barwick
2017-11-29 14:43:28 +09:00
parent f2db9f3ea4
commit f78c169c3d
12 changed files with 102 additions and 1 deletions

View File

@@ -126,6 +126,9 @@
<listitem> <listitem>
<simpara><literal>primary_register</literal></simpara> <simpara><literal>primary_register</literal></simpara>
</listitem> </listitem>
<listitem>
<simpara><literal>primary_unregister</literal></simpara>
</listitem>
<listitem> <listitem>
<simpara><literal>standby_register</literal></simpara> <simpara><literal>standby_register</literal></simpara>
</listitem> </listitem>
@@ -144,6 +147,15 @@
<listitem> <listitem>
<simpara><literal>standby_disconnect_manual</literal></simpara> <simpara><literal>standby_disconnect_manual</literal></simpara>
</listitem> </listitem>
<listitem>
<simpara><literal>witness_register</literal></simpara>
</listitem>
<listitem>
<simpara><literal>witness_unregister</literal></simpara>
</listitem>
<listitem>
<simpara><literal>node_rejoin</literal></simpara>
</listitem>
<listitem> <listitem>
<simpara><literal>repmgrd_start</literal></simpara> <simpara><literal>repmgrd_start</literal></simpara>
</listitem> </listitem>

View File

@@ -45,6 +45,13 @@
</para> </para>
</refsect1> </refsect1>
<refsect1>
<title>Event notifications</title>
<para>
A <literal>node_rejoin</literal> event notification will be generated.
</para>
</refsect1>
<refsect1> <refsect1>
<title>Notes</title> <title>Notes</title>
<para> <para>
@@ -78,7 +85,8 @@
</para> </para>
<note> <note>
<para> <para>
<command>pg_rewind</command> *requires* that either <varname>wal_log_hints</varname> is enabled, or that <command>pg_rewind</command> <emphasis>requires</emphasis> that either
<varname>wal_log_hints</varname> is enabled, or that
data checksums were enabled when the cluster was initialized. See the data checksums were enabled when the cluster was initialized. See the
<ulink url="https://www.postgresql.org/docs/current/static/app-pgrewind.html"><command>pg_rewind</command> documentation</ulink> for details. <ulink url="https://www.postgresql.org/docs/current/static/app-pgrewind.html"><command>pg_rewind</command> documentation</ulink> for details.
</para> </para>

View File

@@ -48,4 +48,11 @@
</note> </note>
</refsect1> </refsect1>
<refsect1>
<title>Event notifications</title>
<para>
A <literal>primary_register</literal> event notification will be generated.
</para>
</refsect1>
</refentry> </refentry>

View File

@@ -31,4 +31,12 @@
<command>repmgr primary unregister</command>/ <command>repmgr primary unregister</command>/
</para> </para>
</refsect1> </refsect1>
<refsect1>
<title>Event notifications</title>
<para>
A <literal>primary_unregister</literal> event notification will be generated.
</para>
</refsect1>
</refentry> </refentry>

View File

@@ -99,5 +99,13 @@
</simpara> </simpara>
</note> </note>
</refsect1> </refsect1>
<refsect1>
<title>Event notifications</title>
<para>
A <literal>standby_clone</literal> event notification will be generated.
</para>
</refsect1>
</refentry> </refentry>

View File

@@ -48,6 +48,13 @@
</para> </para>
</refsect1> </refsect1>
<refsect1>
<title>Event notifications</title>
<para>
A <literal>standby_follow</literal> event notification will be generated.
</para>
</refsect1>
<refsect1> <refsect1>
<title>See also</title> <title>See also</title>
<para> <para>

View File

@@ -41,4 +41,12 @@
DETAIL: server "node2" (ID: 2) was successfully promoted to primary</programlisting> DETAIL: server "node2" (ID: 2) was successfully promoted to primary</programlisting>
</para> </para>
</refsect1> </refsect1>
<refsect1>
<title>Event notifications</title>
<para>
A <literal>standby_promote</literal> event notification will be generated.
</para>
</refsect1>
</refentry> </refentry>

View File

@@ -74,4 +74,13 @@
<literal>-F/--force</literal> option does not result in an incorrectly configured cluster. <literal>-F/--force</literal> option does not result in an incorrectly configured cluster.
</para> </para>
</refsect1> </refsect1>
<refsect1>
<title>Event notifications</title>
<para>
A <literal>standby_register</literal> event notification will be generated.
</para>
</refsect1>
</refentry> </refentry>

View File

@@ -40,6 +40,15 @@
</para> </para>
</refsect1> </refsect1>
<refsect1>
<title>Event notifications</title>
<para>
A <literal>standby_promote</literal> event notification will be generated on the new primary,
and a <literal>node_rejoin</literal> event notification on the former primary (new standby).
</para>
</refsect1>
<refsect1> <refsect1>
<title>See also</title> <title>See also</title>
<para> <para>

View File

@@ -42,5 +42,13 @@
repmgr standby unregister -f /etc/repmgr.conf --node-id=3</programlisting> repmgr standby unregister -f /etc/repmgr.conf --node-id=3</programlisting>
</para> </para>
</refsect1> </refsect1>
<refsect1>
<title>Event notifications</title>
<para>
A <literal>standby_unregister</literal> event notification will be generated.
</para>
</refsect1>
</refentry> </refentry>

View File

@@ -49,4 +49,12 @@
</para> </para>
</refsect1> </refsect1>
<refsect1>
<title>Event notifications</title>
<para>
A <literal>witness_register</literal> event notification will be generated.
</para>
</refsect1>
</refentry> </refentry>

View File

@@ -61,4 +61,13 @@
<link linkend="repmgr-witness-register">repmgr witness register --force</link>. <link linkend="repmgr-witness-register">repmgr witness register --force</link>.
</para> </para>
</refsect1> </refsect1>
<refsect1>
<title>Event notifications</title>
<para>
A <literal>witness_unregister</literal> event notification will be generated.
</para>
</refsect1>
</refentry> </refentry>