Merge pull request #5048 from EnterpriseDB/release/2023-11-28

EnterpriseDB · Nov 28, 2023 · 49dfdf4 · 49dfdf4 · github-actions · Nov 28, 2023
2 parents 06ca5b6 + 08818a6
commit 49dfdf4
Show file tree

Hide file tree

Showing 10 changed files with 188 additions and 39 deletions.
diff --git a/advocacy_docs/community/contributing/index.mdx b/advocacy_docs/community/contributing/index.mdx
@@ -3,6 +3,10 @@ title: Contributing Feedback and More
 navTitle: Contributing
 description: Guidelines for offering feedback to EDB Docs.
 iconName: IdeaSharing
+navigation:
+- repo
+- styleguide
+- releasenotes-styleguide
 ---
 
 All feedback is welcome:

diff --git a/advocacy_docs/community/contributing/releasenotes-styleguide.mdx b/advocacy_docs/community/contributing/releasenotes-styleguide.mdx
@@ -0,0 +1,99 @@
+---
+title: Release Notes Style Guide
+navTitle: Release Notes Style Guide
+iconName: Docs
+description: Our style guide for your release notes
+indexdepth: 3
+rootisheading: true
+deepToC: true
+---
+
+## General guidelines
+
+* For features and enhancements, use second person (you) instead of third person (the user).
+* For bug fixes, avoid referring to the user. Instead describe the software behavior. If the description is clearer by referring to the user, use third person.
+* Follow basic terminology guidelines: 
+    * Don’t use “should” or “would.” Don’t use “will” unless referring to a future release. 
+    * Don’t use “may.” Use “might” or “can” instead.
+    * Use contractions.
+    * Use serial (aka Oxford) commas.
+
+## Phrasing guidelines for enhancements
+
+You can use either of these forms for enhancements. Add as much detail as needed to convey the relevance of the enhancement. If you need to describe how the product worked before, use “previously,” not “currently.”
+
+### Past tense description of the development work
+
+Start with a past-tense word that describes what you did. Then provide any relevant detail. 
+
+#### Examples:
+
+
+> Added support for WHERE clause to the UPDATE and INSERT of the MERGE command for Oracle compatibility.
+
+> Added the ability to copy probes and alerts to all servers in a group without having to select them individually.
+
+> Enabled multi-insert support for the dynamic partition for EDB*Loader and COPY command.
+
+
+### “Now” phrase
+
+Describe what the product now does as a result of the enhancement, generally in the form:
+
+[The product/feature] now [does the new behavior].
+
+#### Examples:
+
+> EDB Postgres Advanced Server now provides INDEX and NO_INDEX hints for the partitioned table. The optimizer hints apply to the inherited index in the partitioned table. The execution plan internally expands to include the corresponding inherited child indexes and applies them in later processing.
+
+> The INTO clause now accepts multiple composite row type targets in SPL. This enhancement allows you to assign a SELECT list having a mix of scalar and composite type values that are fetched from a table to corresponding scalar or composite variables (including collection variables) in the SPL code.
+
+
+### Enhancement don’ts 
+
+* Don’t start the enhancement with a gerund, which suggests the work is still in progress:
+
+
+**Correct:** 
+> Added the XYZ function.
+
+
+**Incorrect:** 
+> Adding the XYZ function.
+
+
+* Don’t use a title or short description:
+
+
+**Correct:** 
+> Added support for WHERE clause to the UPDATE and INSERT of the MERGE command for Oracle compatibility.
+
+
+**Incorrect:** 
+> MERGE syntax. - Adding support for WHERE clause to the UPDATE and INSERT of the MERGE command for Oracle compatibility.
+
+
+**Correct:** 
+> You can now configure the durability options, such as Group Commit, CAMO, Eager Replication, and Lag Control, through Commit Scope.
+
+
+**Incorrect:** 
+> Unified replication durability configuration
+
+> The durability options such as Group Commit, CAMO, Eager Replication, or Lag Control are now all configured through Commit Scope configuration.
+
+
+## Bug fix writing guidelines
+
+Start bug fix descriptions with:
+
+> Fixed an issue whereby…
+
+Or
+
+> Fixed a [such-and-such] issue in which/whereby…
+
+It’s okay to use “the user” in bug fixes. Using second person is generally not accurate. 
+
+Don’t include internal Jira ticket numbers. Do include customer-facing support tickets using this format after the last sentence of the description (or in the Addresses column if your release notes format has that column): #Ticketnumber
+
diff --git a/product_docs/docs/pem/8/pem_rel_notes/865_rel_notes.mdx b/product_docs/docs/pem/8/pem_rel_notes/865_rel_notes.mdx
diff --git a/product_docs/docs/pem/9/pem_rel_notes/941_rel_notes.mdx b/product_docs/docs/pem/9/pem_rel_notes/941_rel_notes.mdx
@@ -0,0 +1,12 @@
+---
+title: "Postgres Enterprise Manager 9.4.1 release notes"
+navTitle: Version 9.4.1
+---
+
+Released: 28 Nov 2023
+
+New features, enhancements, bug fixes, and other changes in PEM 9.4.1 include:
+
+|       Type        |                                                                                                 Description                                                                                                  |
+| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| Security&nbsp;fix | This is a security fix for [CVE-2023-38545](https://nvd.nist.gov/vuln/detail/CVE-2023-38545) and [CVE-2023-38546](https://nvd.nist.gov/vuln/detail/CVE-2023-38546). This patch fixes the libcurl-pem issues. |
diff --git a/product_docs/docs/pem/9/pem_rel_notes/index.mdx b/product_docs/docs/pem/9/pem_rel_notes/index.mdx
@@ -1,6 +1,7 @@
 ---
 title: "Release notes"
 navigation:
+ - 941_rel_notes
  - 940_rel_notes
  - 931_rel_notes
  - 930_rel_notes
@@ -16,6 +17,7 @@ The Postgres Enterprise Manager (PEM) documentation describes the latest version
 
 | Version                   | Release Date | Upstream Merges                                                           | Accessibility Conformance                                                                           |
 | ------------------------- | ------------ | --------------------------------------------------------------------------| --------------------------------------------------------------------------------------------------- |
+| [9.4.1](941_rel_notes)    | 28 Nov 2023  |  NA                                                                       | [Conformance Report](https://www.enterprisedb.com/accessibility)                                    |
 | [9.4.0](940_rel_notes)    | 16 Nov 2023  |  NA                                                                       | [Conformance Report](https://www.enterprisedb.com/accessibility)                                    |
 | [9.3.1](931_rel_notes)    | 12 Oct 2023  |  NA                                                                       | [Conformance Report](https://www.enterprisedb.com/accessibility)                                    |
 | [9.3.0](930_rel_notes)    | 31 Aug 2023  |  NA                                                                       | [Conformance Report](https://www.enterprisedb.com/accessibility)                                    |

diff --git a/product_docs/docs/pem/9/troubleshooting.mdx b/product_docs/docs/pem/9/troubleshooting.mdx
@@ -14,7 +14,7 @@ redirects:
 
 ### RHEL 8
 
-While installing the PEM server on RHEL 8, if you see this error:
+1. While installing the PEM server on RHEL 8, if you see this error:
 
 ```text
 [root@etpgxlt firstuser]# dnf install edb-pem
@@ -31,14 +31,49 @@ Error:
 [root@etpgxlt firstuser]# 
 ```
 
-Remove the `python3-mod_wsgi` package first:
+  Remove the `python3-mod_wsgi` package first:
 
 ```shell
 dnf remove python3-mod_wsgi
 ```
 
 Try installing the PEM server again.
 
+2. On RHEL 8, if you see this error in the worker.log after configuring the PEM server:
+
+```text
+Tue Nov 28 03:02:19 2023 WARNING: Error clearing zombies: ERROR:  failed to JIT module: Added modules have incompatible data layouts: E-m:e-i1:8:16-i8:8:16-i64:64-f128:64-a:8:16-n32:64 (module) vs E-m:e-i1:8:16-i8:8:16-i64:64-f128:64-v128:64-a:8:16-n32:64 (jit)
+CONTEXT:  SQL statement "WITH running_agent_job AS (
+		SELECT j.jobid, j.agent_id
+		FROM pem.job j LEFT JOIN pem.joblog jl ON (j.jobid = jl.jlgjobid)
+		WHERE jl.jlgstatus = 'r' AND agent_id = $1 AND j.jobarid != agent_runtime_id
+		ORDER BY j.jobid, jl.jlgjobid
+		FOR UPDATE SKIP LOCKED
+	), joblog_status_update AS (
+		UPDATE pem.joblog jl SET jlgstatus='d'
+		FROM running_agent_job r
+		WHERE r.jobid = jl.jlgjobid AND jl.jlgstatus='r'
+		RETURNING r.agent_id, jl.jlgjobid, jl.jlgid
+	), jobsteplog_status_update AS (
+		UPDATE pem.jobsteplog js SET jslstatus='d'
+		FROM joblog_status_update jl
+		WHERE js.jsljlgid = jl.jlgid AND js.jslstatus='r'
+		RETURNING jl.agent_id, jl.jlgjobid AS job_id
+	)
+	UPDATE pem.job j SET jobprocessid=NULL, jobnextrun=NULL, jobarid=NULL
+	FROM (SELECT DISTINCT agent_id, job_id FROM jobsteplog_status_update) js
+	WHERE js.job_id = j.jobid"
+PL/pgSQL function pem.clear_job_zombies(integer) line 8 at SQL statement
+```
+
+  To resolve the error, set the `jit` parameter to `off` in `postgresql.conf` file of the backend database server:
+
+  ```ini
+  jit=off
+  ```
+
+  Restart the backend database server.
+
 ### RHEL 7 ppc64le
 
 After installing the PEM server on RHEL 7 ppc64le, you might see the following cipher error in the worker log file:

diff --git a/product_docs/docs/pgd/5/quickstart/further_explore_failover.mdx b/product_docs/docs/pgd/5/quickstart/further_explore_failover.mdx
@@ -387,15 +387,15 @@ kaolin dc1_subgroup [0.0.0.0]        6432
 Enter `exit` to exit the enterprisedb user and return to the admin/root shell. You can now stop the proxy service on this node by running:
 
 ```shell
-sudo systemctl stop pgd-proxy.service
+systemctl stop pgd-proxy.service
 ```
 
 A brief error appears in the lower-right window as the script switches to another proxy. The write leader doesn't change, though, so the switch of proxy doesn't show in the top-left pane where the monitor query is running.
 
 Bring the proxy service on kaftan back by running:
 
 ```shell
-sudo systemctl start pgd-proxy.service
+systemctl start pgd-proxy.service
 ```
 
 !!!Tip Exiting Tmux

diff --git a/product_docs/docs/pgd/5/quickstart/quick_start_aws.mdx b/product_docs/docs/pgd/5/quickstart/quick_start_aws.mdx
@@ -130,7 +130,7 @@ tpaexec configure democluster \
   --edb-postgres-advanced 15 \
   --redwood \
   --location-names dc1 \
-  --pgd-proxy-routing global \
+  --pgd-proxy-routing local \
   --no-git \
   --hostnames-unsorted
 ```
@@ -154,7 +154,7 @@ By default, TPA configures Debian as the default OS for all nodes on AWS.
 
 Specify that the data nodes will be running [EDB Postgres Advanced Server v15](/epas/latest/) (`--edb-postgres-advanced 15`) with Oracle compatibility (`--redwood`). 
 
-You set the notional location of the nodes to `dc1` using `--location-names`. You then set `--pgd-proxy-routing` to `global` so that proxy routing can route traffic to all nodes in the cluster.
+You set the notional location of the nodes to `dc1` using `--location-names`. You then set `--pgd-proxy-routing` to `local` so that proxy routing can route traffic to all nodes within each location.
 
 By default, TPA commits configuration changes to a Git repository. For this example, you don't need to do that, so you pass the `--no-git` flag.
 
@@ -285,11 +285,11 @@ Similarly, use `pgd show-proxies` to display the proxy connection nodes:
 ```shell
 pgd show-proxies
 __OUTPUT__
-Proxy  Group       Listen Addresses Listen Port
------  -----       ---------------- -----------
-kaboom democluster [0.0.0.0]        6432
-kaftan democluster [0.0.0.0]        6432
-kaolin democluster [0.0.0.0]        6432
+Proxy  Group        Listen Addresses Listen Port
+-----  -----        ---------------- -----------
+kaboom dc1_subgroup [0.0.0.0]        6432
+kaftan dc1_subgroup [0.0.0.0]        6432
+kaolin dc1_subgroup [0.0.0.0]        6432
 ```
 
 The proxies provide high-availability connections to the cluster of data nodes for applications. You can connect to the proxies and, in turn, to the database with the command `psql -h kaboom,kaftan,kaolin -p 6432 bdrdb`:

diff --git a/product_docs/docs/pgd/5/quickstart/quick_start_docker.mdx b/product_docs/docs/pgd/5/quickstart/quick_start_docker.mdx
@@ -174,7 +174,7 @@ tpaexec configure democluster \
   --edb-postgres-advanced 15 \
   --redwood \
   --location-names dc1 \
-  --pgd-proxy-routing global \
+  --pgd-proxy-routing local \
   --no-git \
   --hostnames-unsorted
 ```
@@ -196,7 +196,7 @@ Linux as the default image for all nodes.
 
 Specify that the data nodes will be running [EDB Postgres Advanced Server v15](/epas/latest/) (`--edb-postgres-advanced 15`) with Oracle compatibility (`--redwood`). 
 
-You set the notional location of the nodes to `dc1` using `--location-names`. You then set `--pgd-proxy-routing` to `global` so that proxy routing can route traffic to all nodes in the cluster.
+You set the notional location of the nodes to `dc1` using `--location-names`. You then set `--pgd-proxy-routing` to `local` so that proxy routing can route traffic to all nodes within each location.
 
 By default, TPA commits configuration changes to a Git repository. For this example, you don't need to do that, so pass the `--no-git` flag.
 
@@ -291,7 +291,7 @@ The pgd utility, also known as the PGD CLI, lets you control and manage your EDB
 
 You can use it to check the cluster's health by running `pgd check-health`:
 
-```console
+```shell
 pgd check-health
 __OUTPUT__
 Check      Status Message
@@ -306,7 +306,7 @@ enterprisedb@kaboom:~ $
 
 Or, you can use `pgd show-nodes` to ask PGD to show you the data-bearing nodes in the cluster:
 
-```console
+```shell
 pgd show-nodes
 __OUTPUT__
 Node   Node ID    Group        Type Current State Target State Status Seq ID
@@ -319,14 +319,14 @@ enterprisedb@kaboom:~ $
 
 Similarly, use `pgd show-proxies` to display the proxy connection nodes:
 
-```console
+```shell
 pgd show-proxies
 __OUTPUT__
-Proxy  Group       Listen Addresses Listen Port
------  -----       ---------------- -----------
-kaboom democluster [0.0.0.0]        6432
-kaftan democluster [0.0.0.0]        6432
-kaolin democluster [0.0.0.0]        6432
+Proxy  Group        Listen Addresses Listen Port
+-----  -----        ---------------- -----------
+kaboom dc1_subgroup [0.0.0.0]        6432
+kaftan dc1_subgroup [0.0.0.0]        6432
+kaolin dc1_subgroup [0.0.0.0]        6432
 ```
 
 The proxies provide high-availability connections to the cluster of data nodes for applications. You can connect to the proxies and, in turn, to the database with the command `psql -h kaboom,kaftan,kaolin -p 6432 bdrdb`:

diff --git a/product_docs/docs/pgd/5/quickstart/quick_start_linux.mdx b/product_docs/docs/pgd/5/quickstart/quick_start_linux.mdx
@@ -121,7 +121,15 @@ TPA is now installed.
 Run the [`tpaexec configure`](/tpa/latest/tpaexec-configure/) command to generate a configuration folder: 
 
 ```
-tpaexec configure democluster --architecture PGD-Always-ON --platform bare --edb-postgres-advanced 15 --redwood --no-git --location-names dc1 --pgd-proxy-routing global --hostnames-unsorted
+tpaexec configure democluster \
+    --architecture PGD-Always-ON \
+    --platform bare \
+    --edb-postgres-advanced 15 \
+    --redwood \
+    --no-git \
+    --location-names dc1 \
+    --pgd-proxy-routing local \
+    --hostnames-unsorted
 ```
 
 You specify the PGD-Always-ON architecture (`--architecture PGD-Always-ON`), which sets up the configuration for [PGD 5's Always On architectures](https://www.enterprisedb.com/docs/pgd/latest/architectures/). As part of the default architecture, it configures your cluster with three data nodes, cohosting three [PGD Proxy](https://www.enterprisedb.com/docs/pgd/latest/routing/proxy/) servers and a [Barman](https://www.enterprisedb.com/docs/pgd/latest/backup/#physical-backup) node for backup.
@@ -130,7 +138,7 @@ For Linux hosts, specify that you're targeting a "bare" platform (`--platform ba
 
 Specify that the data nodes will be running [EDB Postgres Advanced Server v15](https://www.enterprisedb.com/docs/epas/latest/) (`--edb-postgres-advanced 15`) with Oracle compatibility (`--redwood`).
 
-You set the notional location of the nodes to `dc1` using `--location-names`. You then set `--pgd-proxy-routing` to `global` so that proxy routing can route traffic to all nodes in the cluster.
+You set the notional location of the nodes to `dc1` using `--location-names`. You then set `--pgd-proxy-routing` to `local` so that proxy routing can route traffic to all nodes within each location.
 
 By default, TPA commits configuration changes to a Git repository. For this example, you don't need to do that, so pass the `--no-git` flag.
 
@@ -336,11 +344,11 @@ Similarly, use `pgd show-proxies` to display the proxy connection nodes:
 ```shell
 pgd show-proxies
 __OUTPUT__
-Proxy  Group       Listen Addresses Listen Port
------  -----       ---------------- -----------
-kaboom democluster [0.0.0.0]        6432
-kaftan democluster [0.0.0.0]        6432
-kaolin democluster [0.0.0.0]        6432
+Proxy  Group        Listen Addresses Listen Port
+-----  -----        ---------------- -----------
+kaboom dc1_subgroup [0.0.0.0]        6432
+kaftan dc1_subgroup [0.0.0.0]        6432
+kaolin dc1_subgroup [0.0.0.0]        6432
 ```
 
 The proxies provide high-availability connections to the cluster of data nodes for applications. You can connect to the proxies and, in turn, to the database with the command `psql -h kaboom,kaftan,kaolin -p 6432 bdrdb`: