Skip to content

Commit

Permalink
Merge pull request #5716 from EnterpriseDB/release-23-05-31
Browse files Browse the repository at this point in the history
Release 23-05-31(a)
  • Loading branch information
djw-m authored May 31, 2024
2 parents 83005c0 + ebdbf04 commit c978059
Show file tree
Hide file tree
Showing 21 changed files with 260 additions and 96 deletions.
37 changes: 37 additions & 0 deletions advocacy_docs/community/contributing/styleguide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,8 @@ Included in this guide:
* 11 [Lists](#lists)
* 12 [Images](#images)
* 13 [Dates](#dates)
* 14 [Terminology considerations](#terminology-considerations)
* 15 [Trademark symbols](#trademark-symbols)

## Language and tone

Expand Down Expand Up @@ -594,3 +596,38 @@ When specifying dates for human readability, use the DD mmm YYYY format with a s
When specifying dates as solely numbers, use [ISO8601](https://www.iso.org/iso-8601-date-and-time-format.html) format; YYYY/MM/DD. This is the internationally accepted, disambiguous format and should be used where you may expect the date to be read by automated systems.
## Terminology considerations
### Ambiguity of the term "cluster"
The term "cluster" can refer to different groups of resources in the technological field.
At EDB, the product documentation uses the term "cluster" to refer to several different objects/concepts.
To avoid ambiguity, always use an adjective (describing word) to clarify which of the cluster types you're referring to in the specific context.
Here are a few examples:
**Postgres cluster**: Also known as a [database cluster](/epas/latest/fundamentals/epas_fundamentals/terminology/#database-cluster), a Postgres cluster is a Postgres server that hosts a number of databases in a single file system location.
**PGD cluster**: A [PGD cluster](/pgd/latest/terminology/#pgd-cluster) is a [Postgres Distributed](/pgd/latest/) system with a group of multiple redundant database systems in different locations.
**Kubernetes cluster**: A [Kubernetes cluster](https://kubernetes.io/docs/reference/glossary/?fundamental=true#term-cluster) is a set of multiple nodes that run containerized applications.
### Postgres distributions
EDB products support three types of Postgres distributions:
- PostgreSQL (open-source or community Postgres)
- EDB Postgres Advanced Server (EPAS)
- EDB Postgres Extended Server (PGE)
Although also referred to as "Postgres flavors," the preferred terms are "Postgres" or "Postgres distributions" to refer to all three options.
## Trademark symbols
Use the ™ or ® symbol at least upon the first use of the `EDB Postgres® + [product]` trademark in the body text of a page.
Examples: EDB Postgres® AI, EDB Postgres® Analytics, EDB Postgres® Machine Learning, etc.
For other trademarks, the documentation site already includes a general disclaimer at the footer of every page called "Trademark" which links to https://www.enterprisedb.com/trademarks.
Contrary to the specifications on [Trademarks](https://www.enterprisedb.com/trademarks), don't include the symbol in page titles,
because the symbol can affect how search engines index and find pages.
31 changes: 21 additions & 10 deletions advocacy_docs/edb-postgres-ai/console/agent/install-agent.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,18 +14,25 @@ Before you begin, you need to have the following:

First, find your EnterpriseDB Repos 2.0 token [here](https://www.enterprisedb.com/repos-downloads).

Next, download and run a script to configure your system to access the `beacon-agent` package from the repository. Be sure to replace `<your-token>` with your EDB Repos 2.0 token and replace `<your-subscription-type>` with your subscription type (`standard` or `enterprise`):
Next, set environmental variables for your repos subscription token and your EDB subscription type (standard or enterprise):

```
export EDB_SUBSCRIPTION_TOKEN=<your-repos-token>
export EBD_SUBSCRIPTION_TYPE=<your-subscription-type>
```

Then, download and run a script to configure your system to access the `beacon-agent` package from the repository. Be sure to replace `<your-token>` with your EDB Repos 2.0 token and replace `<your-subscription-type>` with your subscription type (`standard` or `enterprise`):

For RHEL-like or SLES:

```
curl -1sLf 'https://downloads.enterprisedb.com/<your-token>/<your-subscription-type>/setup.rpm.sh' | sudo -E bash
curl -1sSLf 'https://downloads.enterprisedb.com/$EDB_SUBSCRIPTION_TOKEN/$EDB_SUBSCRIPTION_TYPE/setup.rpm.sh' | sudo -E bash
```

For Debian or Ubuntu:

```
curl -1sLf 'https://downloads.enterprisedb.com/<your-token>/<your-subscription-type>>/setup.deb.sh' | sudo -E bash
curl -1sSLf 'https://downloads.enterprisedb.com/$EDB_SUBSCRIPTION_TOKEN/$EDB_SUBSCRIPTION_TYPE/setup.deb.sh' | sudo -E bash
```

2. Install the `beacon-agent` package:
Expand Down Expand Up @@ -62,17 +69,21 @@ Before you begin, you need to have the following:
mkdir ${HOME}/.beacon
```

Next, configure Beacon Agent by setting the access key (the one you obtained the [Creating a machine user]](create_machine_user)) and project ID, and specify the Beacon config directory for storing the configuration file created. Use the following commands:

```
Next, configure Beacon Agent by setting the access key (the one you obtained the [Creating a machine user](create_machine_user)) and project ID:
```
export BEACON_AGENT_ACCESS_KEY=<your-access-key>
export BEACON_AGENT_PROJECT_ID=<your-project-id>
beacon-agent setup -file="$HOME/.beacon/beacon_agent.yaml"
```


Then, specify the Beacon config directory for storing the configuration file and the name of the configuration file to be created there.

These commands set up the necessary parameters for Beacon Agent and execute the setup command to generate the configuration file(`beacon_agent.yaml) in the specified directory.
```
beacon-agent setup -file="$HOME/.beacon/beacon_agent.yaml"
```

During this setup process, an authentication attempt occurs, utilizing the provided access key and project ID. This authentication is necessary for Beacon Agent to communicate with the Beacon server and register with the project successfully.
During the `beacon-agent setup` process, an authentication attempt occurs, utilizing the provided access key and project ID. This authentication is necessary for Beacon Agent to communicate with the Beacon server and register with the project successfully.

If the commands execute as expected, you should see a message indicating that you have authenticated successfully to your EDB Postgres AI project.

Expand Down Expand Up @@ -121,7 +132,7 @@ provider:
- "foo"
- "bar"
host:
resource_id: "Johns-MBP.lan"
resource_id: "postgresql.lan"
tags: []
poll_interval: 5m0s
```
Expand Down
1 change: 1 addition & 0 deletions advocacy_docs/supported-open-source/patroni/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ navigation:
- "#Installing"
- installing_patroni
- installing_etcd
- installing_with_TPA
- "#Using"
- cluster_management
- tips
Expand Down
29 changes: 19 additions & 10 deletions advocacy_docs/supported-open-source/patroni/installing_patroni.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,28 +7,37 @@ tags:
- Patroni
---

Patroni packages are provided through the PGDG `apt` and `yum` repositories.
EDB provides Patroni to customers via the `edb-patroni` package. This package provides Patroni itself and all its dependencies, so there is no need to install additional packages on the Postgres nodes.

See [Platform Compatibility](https://www.enterprisedb.com/resources/platform-compatibility#epas) for the supported OS list (only `Linux x86-64 (amd64)` currently).
As the dependencies no longer have to be installed separately, there is no need to install the python3-cdiff, python3-psutil, python3-psycopg2, python3-ydiff, python3-click, python3-click, python3-six, python3-dateutil, python3-prettytable, python3-pyyaml, python3-urllib3, python3-etcd, python3-dns or python3-certifi packages.

### Debian/Ubuntu
Packages are available for all subscribed customers with a valid EDB account under any entitlement (Community360, Standard, and Enterprise).

!!! Note
The `edb-patroni` does not provide packages for the etcd server needed for the DCS cluster

To install Patroni, configure the [PostgreSQL](https://www.postgresql.org/download/linux/debian/) `apt` repository. Then run:
Once you have the EDB repository configured on all the nodes of the cluster, run the following commands depending on the Linux distribution you are using.

### Debian/Ubuntu

```bash
sudo apt-get install -y patroni
sudo apt-get install -y edb-patroni
```

!!! Note
On Debian and Ubuntu installations, if you've previously installed the Patroni package named `patroni` using the EDB repositories, `apt upgrade` will not replace this package with the `edb-patroni` package. Executing `apt install edb-patroni` will install `edb-patroni` as a replacement of `patroni`.

See [Quick start on Debian 11](debian11_quick_start/#4-patroni) for a more detailed configuration example.

### RHEL/CentOS

You can install Patroni from the [PostgreSQL](https://yum.postgresql.org/) `yum` repository. It requires Extra Packages for Enterprise Linux ([EPEL](https://fedoraproject.org/wiki/EPEL)).

After you configured the repositories, run the following command to install Patroni and its dependencies for etcd:

```bash
sudo dnf install -y patroni patroni-etcd
sudo dnf install -y edb-patroni
```

See [Quick start on RHEL8](rhel8_quick_start/#4-patroni) for a more detailed configuration example.

### Installing community packages

We also support community packages provided through PGDG repositories. Follow the [PGDG deb download instructions](https://www.postgresql.org/download/linux/debian/) to set up the `apt` repository, or the [PGDG rpm download instructions](https://yum.postgresql.org/) for the `yum` repository. Keep in mind that for PGDG rpm repositories you will need to configure Extra Packages for Enterprise Linux ([EPEL](https://fedoraproject.org/wiki/EPEL)).

Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: 'Deploying Patroni with TPA'
navTitle: 'Deploying with TPA'
description: 'Short description on deploying Patroni with TPA'
tags:
- Installation
- Patroni
- TPA
---

### Deploying a Patroni cluster with TPA

The recommended way for deploying Patroni clusters is by doing so with TPA. We recommend going over the [TPA documentation](https://www.enterprisedb.com/docs/tpa/latest/) for further information on deploying M1 architectures with Patroni as the failover manager.
2 changes: 1 addition & 1 deletion product_docs/docs/eprs/7/installing/uninstalling.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Uninstalling Replication Server doesn't remove any databases used as primary nod

Use the Replication Server console or the Replication Server command line interface to delete any existing single-master or multi-master replication systems before you uninstall Replication Server. Otherwise the control-schema objects created in the publication databases or primary nodes remain in those databases. You must then delete these control-schema objects manually, such as by using a SQL command line utility.

If you installed Replication Server using the Replication Server installer program invoked from Stack Builder or StackBuilder Plus, uninstall Replication Server by invoking the `uninstall-xdbreplicationserver` script.
If you installed Replication Server using the Replication Server installer program invoked from StackBuilder Plus, uninstall Replication Server by invoking the `uninstall-xdbreplicationserver` script.

<div id="uninstalling_xdb_rpm_package" class="registered_link"></div>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ You can upgrade to Replication Server 7 using the graphical installer.

1. On the Ready to Install screen, select **Next**.

The remaining screens that appear confirm completion of the installation process and allow you to exit from Stack Builder or StackBuilder Plus.
The remaining screens that appear confirm completion of the installation process and allow you to exit from StackBuilder Plus.

1. After installation completes, the publication server of the new Replication Server product is running, connected to the controller database used by Replication Server 6.2. The subscription server might be running at this point, which is an expected outcome of this process.

Expand Down
24 changes: 10 additions & 14 deletions product_docs/docs/eprs/7/installing/windows.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ EDB provides a graphical interactive installer for Windows. You can access it tw

- Download the graphical installer from the [Downloads page](https://www.enterprisedb.com/software-downloads-postgres#replication-server) and invoke the installer directly. See [Installing directly](/eprs/latest/installing/windows/#installing-directly).

- Use Stack Builder (with PostgreSQL) or StackBuilder Plus (with EDB Postgres Advanced Server) to download the EDB installer package and invoke the graphical installer. See [Using Stack Builder or StackBuilder Plus](/eprs/latest/installing/windows/#using-stack-builder-or-stackbuilder-plus).
- Use StackBuilder Plus (with EDB Postgres Advanced Server) to download the EDB installer package and invoke the graphical installer. See [Using StackBuilder Plus](/eprs/latest/installing/windows/#using-stack-builder-or-stackbuilder-plus).


## Prerequisites
Expand All @@ -27,25 +27,21 @@ EDB provides a graphical interactive installer for Windows. You can access it tw

## Installing directly

After downloading the graphical installer, to start the installation wizard, assume sufficient privileges (superuser or administrator) and double-click the installer icon. If prompted, provide a password.
Download the graphical installer from the [downloads portal](https://www.enterprisedb.com/software-downloads-postgres#replication-server).

Then, assume sufficient privileges (superuser or administrator), and start the installation wizard by double-clicking the installer icon.
If prompted, provide a password.

In some versions of Windows, to invoke the installer with administrator privileges, you need to right-click the installer icon and select **Run as Administrator** from the context menu.

Proceed to [Using the graphical installer](#using-the-graphical-installer).

## Using Stack Builder or StackBuilder Plus

If you're using PostgreSQL, you can invoke the graphical installer with Stack Builder. See [Using Stack Builder](https://www.enterprisedb.com/docs/supported-open-source/postgresql/installing/03_using_stackbuilder/).

1. In Stack Builder, follow the prompts until you get to the module selection page.

1. Expand the **Registration-required and trial products** node.
## Using StackBuilder Plus

1. Expand the **EnterpriseDB Tools** node and select **Replication Server**.

1. Proceed to [Using the graphical installer](#using-the-graphical-installer).
!!! Note
This method is available to EDB Postgres Advanced Server users only. PostgreSQL users must resort to the [direct installation](#installing-directly) method.

If you're using EDB Postgres Advanced Server, you can invoke the graphical installer with StackBuilder Plus. See [Using StackBuilder Plus](/epas/latest/installing/windows/installing_advanced_server_with_the_interactive_installer/using_stackbuilder_plus/).
You can invoke the graphical installer with StackBuilder Plus. See [Using StackBuilder Plus](/epas/latest/installing/windows/installing_advanced_server_with_the_interactive_installer/using_stackbuilder_plus/).

1. In StackBuilder Plus, follow the prompts until you get to the module selection page.

Expand Down Expand Up @@ -74,7 +70,7 @@ If you're using EDB Postgres Advanced Server, you can invoke the graphical insta

- **Admin User** &mdash; The Replication Server administrator user name needed to authenticate some Replication Server actions, such as registering a publication server or subscription server running on this host. You can enter any alphanumeric string for the admin user name. The default admin user name is admin.

- **Admin Password** &mdash; Password of your choice for the Replication Server administrator.
- **Admin Password** &mdash; Password of your choice for the Replication Server administrator.

The admin user and the admin password (in encrypted form) are saved to the `XDB_HOME\etc\edb-repl.conf` configuration file. Select **Next**.

Expand Down
8 changes: 4 additions & 4 deletions product_docs/docs/pgd/4/bdr/scaling.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@ Otherwise, later executions will alter the definition.
`bdr.autopartition()` doesn't lock the actual table. It changes the
definition of when and how new partition maintenance actions take place.

PGD AutoPartition leverages underlying Postgres features that allow a partition
to be attached or detached/dropped without locking the rest of the table
(Autopartion currently only supports this when used with 2nd Quadrant Postgres
11).
PGD Autopartition in PGD 4.3.5 and later leverages underlying Postgres features
that allow a partition to be attached or detached/dropped without locking the
rest of the table. Versions of PGD prior to 4.3.5 don't support this feature and
will lock the tables.

An ERROR is raised if the table isn't RANGE partitioned or a multi-column
partition key is used.
Expand Down
1 change: 1 addition & 0 deletions product_docs/docs/pgd/5/reference/index.json
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,7 @@
"bdrbackwards_compatibility": "/pgd/latest/reference/pgd-settings#bdrbackwards_compatibility",
"bdrtrack_replication_estimates": "/pgd/latest/reference/pgd-settings#bdrtrack_replication_estimates",
"bdrlag_tracker_apply_rate_weight": "/pgd/latest/reference/pgd-settings#bdrlag_tracker_apply_rate_weight",
"bdrenable_auto_sync_reconcile": "/pgd/latest/reference/pgd-settings#bdrenable_auto_sync_reconcile",
"list-of-node-states": "/pgd/latest/reference/nodes#list-of-node-states",
"node-management-commands": "/pgd/latest/reference/nodes#node-management-commands",
"bdr_init_physical": "/pgd/latest/reference/nodes#bdr_init_physical",
Expand Down
1 change: 1 addition & 0 deletions product_docs/docs/pgd/5/reference/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -233,6 +233,7 @@ The reference section is a definitive listing of all functions, views, and comma
* [`bdr.backwards_compatibility`](pgd-settings#bdrbackwards_compatibility)
* [`bdr.track_replication_estimates`](pgd-settings#bdrtrack_replication_estimates)
* [`bdr.lag_tracker_apply_rate_weight`](pgd-settings#bdrlag_tracker_apply_rate_weight)
* [`bdr.enable_auto_sync_reconcile`](pgd-settings#bdrenable_auto_sync_reconcile)


## [Node management](nodes)
Expand Down
4 changes: 4 additions & 0 deletions product_docs/docs/pgd/5/reference/pgd-settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -661,3 +661,7 @@ We monitor how far behind peer nodes are in terms of applying WAL from the local
node and calculate a moving average of the apply rates for the lag tracking.
This parameter specifies how much contribution newer calculated values have in
this moving average calculation. Default value is 0.1.

### `bdr.enable_auto_sync_reconcile`

Default value (from 5.5.1) is off. When enabled, nodes will perform automatic synchronization of data from a node that is furthest ahead with respect to the down node.
2 changes: 2 additions & 0 deletions product_docs/docs/pgd/5/rel_notes/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: "EDB Postgres Distributed release notes"
navTitle: "Release notes"
description: "Release notes for EDB Postgres Distributed"
navigation:
- pgd_5.5.1_rel_notes
- pgd_5.5.0_rel_notes
- pgd_5.4.1_rel_notes
- pgd_5.4.0_rel_notes
Expand All @@ -25,6 +26,7 @@ that introduced the feature.

| Release Date | EDB Postgres Distributed | BDR extension | PGD CLI | PGD Proxy |
|--------------|------------------------------|---------------|---------|-----------|
| 31 Mar 2024 | [5.5.1](pgd_5.5.1_rel_notes) | 5.5.1 | 5.5.0 | 5.5.0 |
| 16 May 2024 | [5.5.0](pgd_5.5.0_rel_notes) | 5.5.0 | 5.5.0 | 5.5.0 |
| 03 Apr 2024 | [5.4.1](pgd_5.4.1_rel_notes) | 5.4.1 | 5.4.0 | 5.4.0 |
| 05 Mar 2024 | [5.4.0](pgd_5.4.0_rel_notes) | 5.4.0 | 5.4.0 | 5.4.0 |
Expand Down
Loading

2 comments on commit c978059

@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.

@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.