Skip to content

Commit

Permalink
Merge pull request #5613 from EnterpriseDB/revert-5570-DOCS-577-PGD-5…
Browse files Browse the repository at this point in the history
….5-Release

Revert "DOCS-577 PGD-5.5-Release"
  • Loading branch information
djw-m authored May 15, 2024
2 parents 3bb84d1 + c69d066 commit 7cde228
Show file tree
Hide file tree
Showing 38 changed files with 440 additions and 913 deletions.

This file was deleted.

2 changes: 0 additions & 2 deletions product_docs/docs/pgd/3.7/harp/01_release_notes/index.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Release Notes
navigation:
- harp2.4.1_rel_notes
- harp2.4.0_rel_notes
- harp2.3.2_rel_notes
- harp2.3.1_rel_notes
Expand All @@ -28,7 +27,6 @@ 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 |
Expand Down
2 changes: 0 additions & 2 deletions product_docs/docs/pgd/4/rel_notes/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
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
Expand Down Expand Up @@ -30,7 +29,6 @@ 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) |
Expand Down
29 changes: 0 additions & 29 deletions product_docs/docs/pgd/4/rel_notes/pgd_4.3.5_rel_notes.mdx

This file was deleted.

6 changes: 3 additions & 3 deletions product_docs/docs/pgd/5/cli/command_ref/index.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: Command reference
navTitle: Command reference
description: A reference guide to the commands available in the PGD CLI.
redirects:
- /pgd/latest/cli/command_ref/pgd_show-camo/
---

The command name for the PGD command line interface is `pgd`.
pgd is the command name for the PGD command line interface.

## Synopsis

Expand Down
19 changes: 3 additions & 16 deletions product_docs/docs/pgd/5/cli/command_ref/pgd_create-proxy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,6 @@ 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]
Expand All @@ -23,14 +19,9 @@ pgd create-proxy [flags]

```text
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)
Example 1 (attach new proxy called proxy-a1 to group bdrgroup)
$ pgd create-proxy --proxy-name proxy-b1 --group-name group_b --proxy-mode any
$ pgd create-proxy --proxy-name proxy-a1 --group-name bdrgroup
proxy created successfully
```
Expand All @@ -40,17 +31,13 @@ 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 "
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ 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.
Expand Down Expand Up @@ -58,7 +57,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 "
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ 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.

Expand Down Expand Up @@ -55,7 +54,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 "
Expand Down
15 changes: 2 additions & 13 deletions product_docs/docs/pgd/5/cli/command_ref/pgd_set-proxy-options.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,20 +15,9 @@ 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.


Expand All @@ -48,13 +37,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=0
$ pgd set-proxy-options --proxy-name proxy-a1 --option listen_address=0.0.0.0 --option listen_port=6432
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 "consensus_grace_period=1h 30m 5s"
$ pgd set-proxy-options --proxy-name proxy-a1 --option "listen_address = 0.0.0.0" --option "listen_port = 6432"
proxy options updated successfully, please restart proxy service
```
Expand Down
12 changes: 6 additions & 6 deletions product_docs/docs/pgd/5/cli/command_ref/pgd_show-groups.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,11 @@ pgd show-groups [flags]
$ pgd show-groups
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 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_c 2808307099 data bdrgroup c false false
group_so 2123208041 subscriber-only bdrgroup c false false
Expand All @@ -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 "
Expand Down
2 changes: 1 addition & 1 deletion product_docs/docs/pgd/5/cli/command_ref/pgd_show-nodes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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 "
Expand Down
14 changes: 7 additions & 7 deletions product_docs/docs/pgd/5/cli/command_ref/pgd_show-proxies.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@ pgd show-proxies [flags]
$ pgd show-proxies
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
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
```

Expand All @@ -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 "
Expand Down
1 change: 0 additions & 1 deletion product_docs/docs/pgd/5/cli/configuring_cli.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
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.
Expand Down
1 change: 0 additions & 1 deletion product_docs/docs/pgd/5/cli/discover_connections.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ 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.
Expand Down
26 changes: 6 additions & 20 deletions product_docs/docs/pgd/5/cli/index.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: "EDB Postgres Distributed Command Line Interface (PGD CLI)"
title: "EDB Postgres Distributed Command Line Interface"
navTitle: "PGD CLI"
indexCards: simple
indexCards: none
navigation:
- installing
- installing_cli
- using_cli
- configuring_cli
- discover_connections
Expand All @@ -13,23 +13,9 @@ 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's the key tool for inspecting and managing cluster resources.
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.

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.
* [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.

Expand All @@ -38,5 +24,5 @@ You can also install it manually on Linux and macOS systems that can connect to
* [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.
-->


12 changes: 0 additions & 12 deletions product_docs/docs/pgd/5/cli/installing/index.mdx

This file was deleted.

21 changes: 0 additions & 21 deletions product_docs/docs/pgd/5/cli/installing/macos.mdx

This file was deleted.

13 changes: 0 additions & 13 deletions product_docs/docs/pgd/5/cli/installing/tpa.mdx

This file was deleted.

Loading

1 comment on commit 7cde228

@github-actions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.