Merge pull request #5570 from EnterpriseDB/DOCS-577-PGD-5.5-Release

DOCS-577 PGD-5.5-Release

product_docs/docs/pgd/3.7/harp/01_release_notes/harp2.4.1_rel_notes.mdx

@@ -0,0 +1,12 @@
+---
+title: "Version 2.4.1"
+---
+
+Released: 16 May 2024
+
+This is a patch release of HARP 2 that includes internal maintenance fixes.
+
+| Type | Description |
+| ---- |------------ |
+| Change | Routine security library upgrades |
+

product_docs/docs/pgd/3.7/harp/01_release_notes/index.mdx

@@ -1,6 +1,7 @@
 ---
 title: Release Notes
 navigation:
+- harp2.4.1_rel_notes
 - harp2.4.0_rel_notes
 - harp2.3.2_rel_notes
 - harp2.3.1_rel_notes
@@ -27,6 +28,7 @@ The release notes in this section provide information on what was new in each re
 
 | Version                  | Release Date |
 | -----------------------  | ------------ |
+| [2.4.1](harp2.4.1_rel_notes)  | 15 May 2024 |
 | [2.4.0](harp2.4.0_rel_notes)  | 05 Mar 2024 |
 | [2.3.2](harp2.3.2_rel_notes)  | 17 Oct 2023 |
 | [2.3.1](harp2.3.1_rel_notes)  | 27 Jul 2023 |

product_docs/docs/pgd/4/rel_notes/index.mdx

@@ -2,6 +2,7 @@
 title: "EDB Postgres Distributed Release notes"
 navTitle: "Release notes"
 navigation:
+- pgd_4.3.5_rel_notes
 - pgd_4.3.4_rel_notes
 - pgd_4.3.3_rel_notes
 - pgd_4.3.2+p1_rel_notes
@@ -29,6 +30,7 @@ The EDB Postgres Distributed documentation describes the latest version of EDB P
 
 | Release Date | EDB Postgres Distributed            | BDR   | HARP  | CLI   | TPAexec                                                      |
 |--------------|-------------------------------------|-------|-------|-------|--------------------------------------------------------------|
+| 16 May 2024  | [4.3.5](pgd_4.3.5_rel_notes)        | 4.3.4 | 2.4.1 | 1.1.2 | [23.32](/tpa/latest/rel_notes/tpa_23.32_rel_notes/)           |
 | 05 Mar 2024  | [4.3.4](pgd_4.3.4_rel_notes)        | 4.3.4 | 2.4   | 1.1.2 | [23.29](/tpa/latest/rel_notes/tpa_23.29_rel_notes/)           |
 | 14 Nov 2023  | [4.3.3](pgd_4.3.3_rel_notes)        | 4.3.3 | 2.3.2 | 1.1.2 | [23.24](/tpa/latest/rel_notes/tpa_23.24_rel_notes)           |
 | 17 Oct 2023  | [4.3.2+p1](pgd_4.3.2+p1_rel_notes)  | 4.3.2 | 2.3.2 | 1.1.1 | [23.20](/tpa/latest/rel_notes/tpa_23.20_rel_notes)           |

product_docs/docs/pgd/4/rel_notes/pgd_4.3.5_rel_notes.mdx

@@ -0,0 +1,29 @@
+---
+title: "Release notes for EDB Postgres Distributed version 4.3.5"
+navTitle: "Version 4.3.5"
+redirects:
+  - /pgd/latest/bdr/release_notes/bdr4.3.5_rel_notes/
+---
+
+Released: 16 May 2024
+
+EDB Postgres Distributed version 4.3.5 is a patch release of EDB Postgres Distributed 4, which includes bug fixes for issues identified in previous versions.
+
+!!! Note
+This version is required for EDB Postgres Advanced Server versions 12.15, 13.11, 14.10, 15.5, and later.
+!!!
+
+| Component | Version | Type        | Description                                                                                                    | Addresses      |
+|-----------|---------|-------------|----------------------------------------------------------------------------------------------------------------|----------------|
+| HARP      | 2.4.1   | Change      | Routine security library upgrades.                                                                             |                |
+| BDR       | 4.3.5   | Enhancement | BDR now logs the completion of an extension upgrade.                                                           |                |
+| BDR       | 4.3.5   | Enhancement | Each autopartition task is now executed in its own transaction.                                                |                |
+| BDR       | 4.3.5   | Enhancement | DETACH CONCURRENTLY is now used to drop partitions.                                                            | RT101407/35476 |
+| BDR       | 4.3.5   | Enhancement | `bdr_superuser` is now granted use of `pg_file_settings` and `pg_show_all_file_settings()`.                    |                |
+| BDR       | 4.3.5   | Enhancement | `bdr_init_physical` now stops the initial replication connection and starts it only when needed.               | RT102828/35305 |
+| BDR       | 4.3.5   | Bug Fix     | Improved handling of node group configuration parameter `check_constraints`.                                   | RT99956/31896  |
+| BDR       | 4.3.5   | Bug Fix     | Fixed an issue to prevent potential segfault in `bdr.monitor_group_versions()`.                                | RT102290/34051 |
+| BDR       | 4.3.5   | Bug Fix     | BDR now uses `bdr.default_sequence_kind` when updating sequence kind of existing sequences upon node creation. |                |
+| BDR       | 4.3.5   | Bug Fix     | Manage rights elevation for trusted extensions                                                                 |                |
+
+

product_docs/docs/pgd/5/cli/command_ref/index.mdx

@@ -1,10 +1,10 @@
 ---
 title: Command reference
-redirects:
-  - /pgd/latest/cli/command_ref/pgd_show-camo/
+navTitle: Command reference
+description: A reference guide to the commands available in the PGD CLI.
 ---
 
-pgd is the command name for the PGD command line interface.
+The command name for the PGD command line interface is `pgd`.
 
 ## Synopsis
 

product_docs/docs/pgd/5/cli/command_ref/pgd_create-proxy.mdx

@@ -10,6 +10,10 @@ Creates proxy in the EDB Postgres Distributed cluster and attaches it to the
 given group. The proxy name must be unique across the cluster and match with
 the name given in the corresponding proxy config file.
 
+Use the proxy mode to route connections to Write Leader (default), Read Nodes
+(read-only), or both (any). Proxy listens on 'listen_port' for Write Leader
+connections while on 'read_listen_port' for Read Nodes connections.
+
 
 ```sh
 pgd create-proxy [flags]
@@ -19,9 +23,14 @@ pgd create-proxy [flags]
 
 ```text
 
-  Example 1 (attach new proxy called proxy-a1 to group bdrgroup)
+  Example 1 (attach new proxy called proxy-a1 to group group_a, with 'default' mode)
+
+  $ pgd create-proxy --proxy-name proxy-a1 --group-name group_a
+  proxy created successfully
+
+  Example 2 (attach new proxy called proxy-b1 to group group_b, with 'any' mode)
 
-  $ pgd create-proxy --proxy-name proxy-a1 --group-name bdrgroup
+  $ pgd create-proxy --proxy-name proxy-b1 --group-name group_b --proxy-mode any
   proxy created successfully
 
 ```
@@ -31,13 +40,17 @@ pgd create-proxy [flags]
 ```text
       --group-name string   group name
   -h, --help                help for create-proxy
+      --proxy-mode string   proxy mode (default, read-only, any); proxy will route connections to -
+                            default - Write Leader
+                            read-only - Read Nodes
+                            any - both Write Leader and Read Nodes (default "default")
       --proxy-name string   proxy name
 ```
 
 ### Options inherited from parent commands
 
 ```text
-  -f, --config-file string   config file; ignored if 
+  -f, --config-file string   config file; ignored if
                              --dsn flag is present (default "/etc/edb/pgd-cli/pgd-cli-config.yml")
       --dsn string           database connection string
                              e.g."host=bdr-a1 port=5432 dbname=bdrdb user=postgres "

product_docs/docs/pgd/5/cli/command_ref/pgd_set-group-options.mdx

@@ -12,6 +12,7 @@ You can set the following group options with this command:
 - 'enable_proxy_routing'
 - 'location'
 - 'route_writer_max_lag'
+- 'route_reader_max_lag'
 
 Both 'enable_raft' and 'enable_proxy_routing' must be true if proxy is
 attached to the group.
@@ -57,7 +58,7 @@ pgd set-group-options [flags]
 ### Options inherited from parent commands
 
 ```text
-  -f, --config-file string   config file; ignored if 
+  -f, --config-file string   config file; ignored if
                              --dsn flag is present (default "/etc/edb/pgd-cli/pgd-cli-config.yml")
       --dsn string           database connection string
                              e.g."host=bdr-a1 port=5432 dbname=bdrdb user=postgres "

product_docs/docs/pgd/5/cli/command_ref/pgd_set-node-options.mdx

@@ -12,6 +12,7 @@ You can set the following node options with this command:
 - 'route_fence'
 - 'route_priority'
 - 'route_writes'
+- 'route_reads'
 
 Use 'pgd show-nodes -o json' to view option values for each node.
 
@@ -54,7 +55,7 @@ pgd set-node-options [flags]
 ### Options inherited from parent commands
 
 ```text
-  -f, --config-file string   config file; ignored if 
+  -f, --config-file string   config file; ignored if
                              --dsn flag is present (default "/etc/edb/pgd-cli/pgd-cli-config.yml")
       --dsn string           database connection string
                              e.g."host=bdr-a1 port=5432 dbname=bdrdb user=postgres "

product_docs/docs/pgd/5/cli/command_ref/pgd_set-proxy-options.mdx

@@ -15,9 +15,20 @@ You can set the following proxy options with this command:
 - 'server_conn_keepalive'
 - 'server_conn_timeout'
 - 'consensus_grace_period'
+- 'read_listen_address'
+- 'read_listen_port'
+- 'read_max_client_conn'
+- 'read_max_server_conn'
+- 'read_server_conn_keepalive'
+- 'read_server_conn_timeout'
+- 'read_consensus_grace_period'
 
 After updating any of these options, restart proxy.
 
+Set 'listen_port' to non-zero value to route traffic to the Write Leader and
+set 'read_listen_port' to non-zero value to route traffic to Read nodes.
+Setting it to zero will disable the respective routing.
+
 Use 'pgd show-proxies -o json' to view option values for each proxy.
 
 
@@ -37,13 +48,13 @@ pgd set-proxy-options [flags]
 
   Example 2 (multiple --option flags are allowed)
 
-  $ pgd set-proxy-options --proxy-name proxy-a1 --option listen_address=0.0.0.0 --option listen_port=6432
+  $ pgd set-proxy-options --proxy-name proxy-a1 --option listen_address=0.0.0.0 --option listen_port=0
   proxy options updated successfully, please restart proxy service
 
 
   Example 3 (use double quote if option value has spaces or special characters)
 
-  $ pgd set-proxy-options --proxy-name proxy-a1 --option "listen_address = 0.0.0.0" --option "listen_port = 6432"
+  $ pgd set-proxy-options --proxy-name proxy-a1 --option "listen_address = 0.0.0.0" --option "consensus_grace_period=1h 30m 5s"
   proxy options updated successfully, please restart proxy service
 
 ```

product_docs/docs/pgd/5/cli/command_ref/pgd_show-groups.mdx

@@ -30,11 +30,11 @@ pgd show-groups [flags]
 
   $ pgd show-groups
 
-  Group    Group ID   Type            Parent Group Location Raft  Routing Write Leader
-  -----    --------   ----            ------------ -------- ----  ------- ------------
-  bdrgroup 1360502012 global                                true  false
-  group_a  3618712053 data            bdrgroup     a        true  true    bdr-a1
-  group_b  402614658  data            bdrgroup     b        true  true    bdr-b1
+  Group    Group ID   Type            Parent Group Location Raft  Routing Raft Leader Write Leader
+  -----    --------   ----            ------------ -------- ----  ------- ----------- ------------
+  bdrgroup 1360502012 global                       world    true  false   bdr-a2
+  group_a  3618712053 data            bdrgroup     a        true  true    bdr-a2      bdr-a1
+  group_b  402614658  data            bdrgroup     b        true  true    bdr-b1      bdr-b1
   group_c  2808307099 data            bdrgroup     c        false false
   group_so 2123208041 subscriber-only bdrgroup     c        false false
 
@@ -49,7 +49,7 @@ pgd show-groups [flags]
 ### Options inherited from parent commands
 
 ```text
-  -f, --config-file string   config file; ignored if 
+  -f, --config-file string   config file; ignored if
                              --dsn flag is present (default "/etc/edb/pgd-cli/pgd-cli-config.yml")
       --dsn string           database connection string
                              e.g."host=bdr-a1 port=5432 dbname=bdrdb user=postgres "

product_docs/docs/pgd/5/cli/command_ref/pgd_show-nodes.mdx

@@ -95,7 +95,7 @@ pgd show-nodes [flags]
 ### Options inherited from parent commands
 
 ```text
-  -f, --config-file string   config file; ignored if 
+  -f, --config-file string   config file; ignored if
                              --dsn flag is present (default "/etc/edb/pgd-cli/pgd-cli-config.yml")
       --dsn string           database connection string
                              e.g."host=bdr-a1 port=5432 dbname=bdrdb user=postgres "

product_docs/docs/pgd/5/cli/command_ref/pgd_show-proxies.mdx

@@ -24,12 +24,12 @@ pgd show-proxies [flags]
 
   $ pgd show-proxies
 
-  Proxy    Group   Listen Addresses Listen Port
-  -----    -----   ---------------- -----------
-  proxy-a1 group_a [0.0.0.0]        6432
-  proxy-a2 group_a [0.0.0.0]        6432
-  proxy-b1 group_b [0.0.0.0]        6432
-  proxy-b2 group_b [0.0.0.0]        6432
+  Proxy    Group   Listen Addrs Listen Port Read Listen Addrs Read Listen Port
+  -----    -----   ------------ ----------- ----------------- ----------------
+  proxy-a1 group_a [0.0.0.0]    6432        [0.0.0.0]         6433
+  proxy-a2 group_a [0.0.0.0]    6432        [0.0.0.0]         6433
+  proxy-b1 group_b [0.0.0.0]    6432        [0.0.0.0]         6433
+  proxy-b2 group_b [0.0.0.0]    6432        [0.0.0.0]         6433
 
 ```
 
@@ -42,7 +42,7 @@ pgd show-proxies [flags]
 ### Options inherited from parent commands
 
 ```text
-  -f, --config-file string   config file; ignored if 
+  -f, --config-file string   config file; ignored if
                              --dsn flag is present (default "/etc/edb/pgd-cli/pgd-cli-config.yml")
       --dsn string           database connection string
                              e.g."host=bdr-a1 port=5432 dbname=bdrdb user=postgres "

product_docs/docs/pgd/5/cli/configuring_cli.mdx

@@ -1,6 +1,7 @@
 ---
 title: "Configuring PGD CLI"
 navTitle: "Configuring PGD CLI"
+description: "Configuring PGD CLI for simpler connections to your PGD cluster"
 ---
 
 PGD CLI can be installed on any system that can connect to the PGD cluster. To use PGD CLI, you need a user with PGD superuser privileges or equivalent. The PGD user with superuser privileges is the [bdr_superuser role](../security). An example of an equivalent user is edb_admin on a BigAnimal distributed high-availability cluster.

product_docs/docs/pgd/5/cli/discover_connections.mdx

@@ -3,6 +3,7 @@ title: "Discovering connection strings"
 navTitle: "Discovering connection strings"
 indexdepth: 2
 deepToC: true
+description: "How to obtain the correct connection strings for your PGD-powered deployment."
 ---
 
 You can install PGD CLI on any system that can connect to the PGD cluster. To use PGD CLI, you need a user with PGD superuser privileges or equivalent. The PGD user with superuser privileges is the [bdr_superuser role](../security). An example of an equivalent user is edb_admin on an EDB BigAnimal distributed high-availability cluster.

product_docs/docs/pgd/5/cli/index.mdx

@@ -1,9 +1,9 @@
 ---
-title: "EDB Postgres Distributed Command Line Interface"
+title: "EDB Postgres Distributed Command Line Interface (PGD CLI)"
 navTitle: "PGD CLI"
-indexCards: none
+indexCards: simple
 navigation:
-- installing_cli
+- installing
 - using_cli
 - configuring_cli
 - discover_connections
@@ -13,9 +13,23 @@ directoryDefaults:
   description: "The PGD Command Line Interface (CLI) is a tool to manage your EDB Postgres Distributed cluster"
 ---
 
-The EDB Postgres Distributed Command Line Interface (PGD CLI) is a tool for managing your EDB Postgres Distributed cluster. It allows you to run commands against EDB Postgres Distributed clusters. It's installed automatically on systems in a TPA-deployed PGD cluster. Or it can be installed manually on systems that can connect to any PGD cluster, such as EDB BigAnimal distributed high-availability clusters or PGD clusters deployed using the EDB PGD for Kubernetes operator.
+The EDB Postgres Distributed Command Line Interface (PGD CLI) is a tool for managing your EDB Postgres Distributed cluster. It's the key tool for inspecting and managing cluster resources.
 
-* [Installing PGD CLI](installing_cli) has instructions on manually installing PGD CLI on various systems.
+It allows you to run commands against EDB Postgres Distributed clusters to:
+ * Determine the health of the cluster, inspect the cluster's configuration, and manage the cluster's resources. 
+ * Inspect and manage the cluster's nodes, groups, and proxies.
+ * Perform switchover operations on the write leaders of groups.
+
+PGD CLI is installed automatically on systems in a TPA-deployed PGD cluster. 
+
+You can also install it manually on Linux and macOS systems that can connect to a PGD cluster, including:
+  * EDB BigAnimal distributed high-availability clusters.
+  * PGD clusters deployed using the EDB PGD for Kubernetes operator.
+  * Manually deployed PGD clusters.
+  * TPA-deployed PGD clusters.
+
+
+<!-- * [Installing PGD CLI](installing_cli) has instructions on manually installing PGD CLI on various systems.
 
 * [Using PGD CLI](using_cli) offers an introduction to using the PGD CLI and how to connect to your PGD cluster.
 
@@ -24,5 +38,5 @@ The EDB Postgres Distributed Command Line Interface (PGD CLI) is a tool for mana
 * [PGD CLI's Command reference](command_ref) covers all the available commands to inspect, manage, and get information about cluster resources.
 
 * [Discovering connection strings](discover_connections) shows how to obtain the correct connection strings for your PGD-powered deployment.
-
+ -->
 

product_docs/docs/pgd/5/cli/installing/index.mdx

@@ -0,0 +1,12 @@
+---
+title: "Installing PGD CLI"
+navTitle: "Installing PGD CLI"
+redirects:
+  - /pgd/latest/cli/installing_cli
+deepToC: true
+indexCards: simple
+description: Installing the PGD CLI on various systems.
+---
+
+You can install PGD CLI on any system that can connect to the PGD cluster. Linux and macOS are currently supported platforms to install PGD CLI on.
+