ci(FS-7080): Update trufflehog-scan.yml

Merge pull request #782 from EnterpriseDB/Fixed-reported-phrase
Update configuration-file-optional-settings.xml
2026-03-23 07:06:30 +00:00 · 2024-01-30 11:25:57 -05:00 · 2023-07-04 09:04:04 -03:00 · 2023-07-04 14:02:08 +02:00 · 2023-06-08 16:35:56 +09:00 · 2023-04-17 12:57:51 -03:00
7 changed files with 203 additions and 4 deletions
--- a/.github/workflows/trufflehog-scan.yml
+++ b/.github/workflows/trufflehog-scan.yml
@@ -0,0 +1,43 @@
+###
+# Foundation-security Trufflehog workflow
+# version: 2.0
+###
+name: Foundation-Security/Trufflehog Scan
+
+on:
+  push:
+    tags:
+      - "**"
+    branches:
+      - "**"
+
+jobs:
+  Trufflehog-Scan:
+    runs-on: ubuntu-22.04
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+      - name: Checkout source repository
+        id: checkout-source
+        uses: actions/checkout@v4
+        with:
+          repository: ${{github.repository}}
+          ref: ${{ github.ref }}
+          path: source
+          token: ${{secrets.GH_SLONIK}}
+
+      - name: Checkout foundation-security repository
+        id: checkout-foundation-security
+        uses: actions/checkout@v4
+        with:
+          repository: EnterpriseDB/foundation-security
+          ref: v2
+          path: foundation-security
+          token: ${{secrets.GH_SLONIK}}
+
+      - name: Secrets Scan
+        id: call-th-composite
+        uses: ./foundation-security/actions/trufflehog
+        with:
+          cloudsmith-token: ${{ secrets.CLOUDSMITH_READ_ALL }}
--- a/6
+++ b/6
@@ -1,3 +1,9 @@
+5.4.1   2023-??-??
+        repmgrd: ensure witness node metadata is updated (Ian)
+
+5.4.0   2023-03-16
+        Support cloning replicas using pg-backup-api
+
 5.3.3   2022-10-17
        Support for PostgreSQL added
        repmgrd: ensure event notification script is called for event
--- a/README.md
+++ b/README.md
@@ -8,7 +8,7 @@ replication, and perform administrative tasks such as failover or switchover
 operations.

 The most recent `repmgr` version (5.3.2) supports all PostgreSQL versions from
-9.5 to 14. PostgreSQL 9.4 is also supported, with some restrictions.
+9.5 to 15. PostgreSQL 9.4 is also supported, with some restrictions.

 `repmgr` is distributed under the GNU GPL 3 and maintained by EnterpriseDB.

--- a/doc/appendix-release-notes.xml
+++ b/doc/appendix-release-notes.xml
@@ -16,8 +16,44 @@
  </para>

  <!-- remember to update the release date in ../repmgr_version.h.in -->
+  <sect1 id="release-5.4.1">
+    <title id="release-current">Release 5.4.1</title>
+    <para><emphasis>??? ?? ??????, 202?</emphasis></para>
+    <para>
+      &repmgr; 5.4.1 is a minor release providing ...
+    </para>
+    <sect2>
+      <title>Bug fixes</title>
+      <para>
+        <itemizedlist>
+          <listitem>
+            <para>
+              &repmgrd;: ensure witness node metadata is updated if the primary
+              node changed while the witness &repmgrd; was not running.
+            </para>
+          </listitem>
+        </itemizedlist>
+      </para>
+    </sect2>
+  </sect1>
+
+  <sect1 id="release-5.4.0">
+    <title>Release 5.4.0</title>
+    <para><emphasis>Thu 15 March, 2023</emphasis></para>
+    <para>
+      &repmgr; 5.4.0 is a major release.
+    </para>
+    <para>
+      This release provides support for cloning standbys using backups taken with <ulink url="http://www.pgbarman.org">barman</ulink>
+      with the use of <ulink url="https://github.com/EnterpriseDB/pg-backup-api">pg-backup-api</ulink>.
+    </para>
+    <para>
+      Minor fixes to the documentation.
+    </para>
+  </sect1>
+
  <sect1 id="release-5.3.3">
-    <title id="release-current">Release 5.3.3</title>
+    <title>Release 5.3.3</title>
    <para><emphasis>Mon 17 October, 2022</emphasis></para>
    <para>
      &repmgr; 5.3.3 is a minor release providing support for
--- a/doc/cloning-standbys.xml
+++ b/doc/cloning-standbys.xml
@@ -225,6 +225,109 @@ description = "Main cluster"
   </note>

  </sect2>
+
+  <sect2 id="cloning-from-barman-pg_backupapi-mode" xreflabel="Using Barman through its API (pg-backup-api)">
+    <title>Using Barman through its API (pg-backup-api)</title>
+    <indexterm>
+      <primary>cloning</primary>
+      <secondary>pg-backup-api</secondary>
+    </indexterm>
+
+    <para>
+      You can find information on how to install and setup pg-backup-api in
+      <ulink url="https://www.enterprisedb.com/docs/supported-open-source/barman/pg-backup-api/">the pg-backup-api
+      documentation</ulink>.
+    </para>
+
+    <para>
+      This mode (`pg-backupapi`) was introduced in v5.4.0 as a way to further integrate with Barman letting Barman
+      handle the restore. This also reduces the ssh keys that need to share between the backup and postgres nodes.
+      As long as you have access to the API service by HTTP calls, you could perform recoveries right away.
+      You just need to instruct Barman through the API which backup you need and on which node the backup needs to
+      to be restored on.
+    </para>
+
+    <para>
+      In order to enable <literal>pg_backupapi mode</literal> support for <command>repmgr standby clone</command>,
+      you need the following lines in repmgr.conf:
+      <itemizedlist spacing="compact" mark="bullet">
+        <listitem><para>pg_backupapi_host: Where pg-backup-api is hosted</para></listitem>
+        <listitem><para>pg_backupapi_node_name: Name of the server as understood by Barman</para></listitem>
+        <listitem><para>pg_backupapi_remote_ssh_command: How Barman will be connecting as to the node</para></listitem>
+        <listitem><para>pg_backupapi_backup_id: ID of the existing backup you need to restore</para></listitem>
+      </itemizedlist>
+
+      This is an example of how repmgr.conf would look like:
+
+      <programlisting>
+        pg_backupapi_host = '192.168.122.154'
+        pg_backupapi_node_name = 'burrito'
+        pg_backupapi_remote_ssh_command = 'ssh john_doe@192.168.122.1'
+        pg_backupapi_backup_id = '20230223T093201'
+      </programlisting>
+    </para>
+
+    <para>
+      <literal>pg_backupapi_host</literal> is the variable name that enables this mode, and when you set it,
+      all the rest of the above variables are required. Also, remember that this service is just an interface
+      between Barman and repmgr, hence if something fails during a recovery, you should check Barman's logs upon
+      why the process couldn't finish properly.
+    </para>
+
+    <note>
+      <simpara>
+        Despite in Barman you can define shortcuts like "lastest" or "oldest", they are not supported for the
+        time being in pg-backup-api. These shortcuts will be supported in a future release.
+      </simpara>
+     </note>
+
+    <para>
+      This is a real example of repmgr's output cloning with the API. Note that during this operation, we stopped
+      the service for a little while and repmgr had to retry but that doesn't affect the final outcome. The primary
+      is listening on localhost's port 6001:
+
+      <programlisting>
+$ repmgr -f ~/nodes/node_3/repmgr.conf standby clone -U repmgr -p 6001 -h localhost
+NOTICE: destination directory "/home/mario/nodes/node_3/data" provided
+INFO: Attempting to use `pg_backupapi` new restore mode
+INFO: connecting to source node
+DETAIL: connection string is: user=repmgr port=6001 host=localhost
+DETAIL: current installation size is 8541 MB
+DEBUG: 1 node records returned by source node
+DEBUG: connecting to: "user=repmgr dbname=repmgr host=localhost port=6001 connect_timeout=2 fallback_application_name=repmgr options=-csearch_path="
+DEBUG: upstream_node_id determined as 1
+INFO: Attempting to use `pg_backupapi` new restore mode
+INFO: replication slot usage not requested;  no replication slot will be set up for this standby
+NOTICE: starting backup (using pg_backupapi)...
+INFO: Success creating the task: operation id '20230309T150647'
+INFO: status IN_PROGRESS
+INFO: status IN_PROGRESS
+Incorrect reply received for that operation ID.
+INFO: Retrying...
+INFO: status IN_PROGRESS
+INFO: status IN_PROGRESS
+INFO: status IN_PROGRESS
+INFO: status IN_PROGRESS
+INFO: status IN_PROGRESS
+INFO: status IN_PROGRESS
+INFO: status IN_PROGRESS
+INFO: status IN_PROGRESS
+INFO: status IN_PROGRESS
+INFO: status IN_PROGRESS
+INFO: status IN_PROGRESS
+INFO: status IN_PROGRESS
+INFO: status IN_PROGRESS
+INFO: status IN_PROGRESS
+INFO: status IN_PROGRESS
+INFO: status DONE
+NOTICE: standby clone (from pg_backupapi) complete
+NOTICE: you can now start your PostgreSQL server
+HINT: for example: pg_ctl -D /home/mario/nodes/node_3/data start
+HINT: after starting the server, you need to register this standby with "repmgr standby register"
+      </programlisting>
+
+    </para>
+  </sect2> <!--END cloning-from-barman-pg_backupapi-mode !-->
 </sect1>

 <sect1 id="cloning-replication-slots" xreflabel="Cloning and replication slots">
--- a/doc/configuration-file-optional-settings.xml
+++ b/doc/configuration-file-optional-settings.xml
@@ -10,8 +10,8 @@
  <note>
    <simpara>
      This section documents a subset of optional configuration settings; for a full
-      for a full and annotated view of all configuration options see the
-      see the <ulink url="https://raw.githubusercontent.com/EnterpriseDB/repmgr/master/repmgr.conf.sample">sample repmgr.conf file</ulink>
+      and annotated view of all configuration options see the
+      <ulink url="https://raw.githubusercontent.com/EnterpriseDB/repmgr/master/repmgr.conf.sample">sample repmgr.conf file</ulink>
    </simpara>
  </note>

--- a/repmgrd-physical.c
+++ b/repmgrd-physical.c
@@ -2394,6 +2394,17 @@ monitor_streaming_witness(void)
 			terminate(ERR_BAD_CONFIG);
 		}

+		/*
+		 * It's possible that the primary changed while the witness repmgrd was not
+		 * running. This does not affect the functionality of the witness repmgrd, but
+		 * does mean outdated node metadata will be displayed, so update that.
+		 */
+		if (local_node_info.upstream_node_id != primary_node_id)
+		{
+			update_node_record_set_upstream(primary_conn, local_node_info.node_id, primary_node_id);
+			local_node_info.upstream_node_id = primary_node_id;
+		}
+
 		initPQExpBuffer(&event_details);

 		appendPQExpBuffer(&event_details,
Author	SHA1	Message	Date
John Sapienza	5dca01ac83	ci(FS-7080): Update trufflehog-scan.yml	2024-01-30 11:25:57 -05:00
Martín Marqués	d3b1ff45b0	Merge pull request #782 from EnterpriseDB/Fixed-reported-phrase Update configuration-file-optional-settings.xml	2023-07-04 09:04:04 -03:00
Martín Marqués	450786ec29	Typo in the documentation Signed-off-by: Martín Marqués <martin.marques@enterprisedb.com>	2023-07-04 14:02:08 +02:00
Ian Barwick	70b34308cc	repmgrd: ensure witness node metadata is updated If the primary changed while the witness repmgrd was not running, ensure the witness's upstream node ID is updated when the witness repmgrd is restarted.	2023-06-08 16:35:56 +09:00
Martín Marqués	19c92a7092	Merge pull request #803 from Nyantechnolog/patch-1 Update README.md	2023-04-17 12:57:51 -03:00
Sidorov Pavel	520ff25ef3	Update README.md upd upper version according to https://repmgr.org	2023-04-04 11:54:59 +03:00
Martín Marqués	8e81c04b4a	Add release notes for repmgr release 5.4.0 This release added support for pg-backup-api. Here we add the release notes which expose the new feature. Signed-off-by: Martín Marqués <martin.marques@enterprisedb.com>	2023-03-24 15:05:03 +00:00
Martín Marqués	aad988c292	Merge pull request #800 from EnterpriseDB/update-docs-for-pg-backupapi-mode Adding new mode to clone standbys.	2023-03-16 07:14:33 -03:00
Martín Marqués	43b8a5f65f	Various improvements and fixes to the pg-backup-api restore section on the docs I added a paragraph at the beginning of the section on where to look for instructions on how to install the pg-backup-api rest API. Fixed typos and some gramatical changes. Also reworded the first paragraph (which is now the second one). Signed-off-by: Martín Marqués <martin.marques@enterprisedb.com>	2023-03-14 11:39:22 +01:00
Martín Marqués	26cfb56170	New sect2 block has to be inside the sect1. The closing tag has to go at the end. Signed-off-by: Martín Marqués <martin.marques@enterprisedb.com>	2023-03-14 10:14:16 +01:00
Mario Gonzalez	f0cc225de0	Adding new mode to clone standbys. repmgr v5.4.0 supports this new mode called `pg_backupapi` which is enabled by defining `pg_backupapi_host` in repmgr.conf.	2023-03-13 11:03:02 -03:00
Dee Dee Rothery	4c95d8d75e	Update configuration-file-optional-settings.xml	2022-12-08 06:26:52 -05:00