Skip to content

Commit

Permalink
Merge pull request #4273 from EnterpriseDB/release/2023-06-20a
Browse files Browse the repository at this point in the history
Release: 2023-06-20a
  • Loading branch information
drothery-edb authored Jun 20, 2023
2 parents 2173919 + 2f2ab3b commit a39f9fa
Show file tree
Hide file tree
Showing 56 changed files with 174 additions and 138 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ redirects:
{{ super() }}
{% endblock product_prerequisites %}
{% block postinstall %}
Where `<4x>` is the version of Failover Manager that you are installing. For example, if you are installing version 4.6, the package name would be `edb-efm46`.
Where `<4x>` is the version of Failover Manager that you are installing. For example, if you are installing version 4.7, the package name would be `edb-efm47`.

The installation process creates a user named efm that has privileges to invoke scripts that control the Failover Manager service for clusters owned by enterprisedb or postgres.

Expand Down
9 changes: 4 additions & 5 deletions product_docs/docs/edb_plus/41/02a_supported_platforms.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,13 @@
title: "Supported platforms"
---

EDB\*Plus is supported on the same platforms as EDB Postgres Advanced Server. To determine the platform support for EDB\*Plus, you can either refer to the platform support for EDB Postgres Advanced Server on the [Platform Compatibility page](https://www.enterprisedb.com/platform-compatibility#epas) on the EDB website or refer to [Installing EDB\*Plus](./installing).

## Supported database versions

The following list of EDB Postgres Advanced Server (EPAS) versions are currently supported for use with EDB\*Plus:
- EPAS 15
- EPAS 14
- EPAS 13
- EPAS 12
- EPAS 11

EDB\*Plus is supported on the same platforms as EDB Postgres Advanced Server. See [Product Compatibility](https://www.enterprisedb.com/platform-compatibility#epas) for details about the support periods and supported platforms for each EDB Postgres Advanced Server version.



Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Each node in a Failover Manager cluster has a properties file (by default, named
After completing the Failover Manager installation, make a working copy of the template before modifying the file contents:

```text
# cp /etc/edb/efm-4.6/efm.properties.in /etc/edb/efm-4.6/efm.properties
# cp /etc/edb/efm-4.7/efm.properties.in /etc/edb/efm-4.7/efm.properties
```

After copying the template file, change the owner of the file to efm:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ This example shows using the `encrypt` utility to encrypt a password for the `ac
# efm encrypt acctg
This utility will generate an encrypted password for you to place in
your Failover Manager cluster property file:
/etc/edb/efm-4.6/acctg.properties
/etc/edb/efm-4.7/acctg.properties
Please enter the password and hit enter:
Please enter the password again to confirm:
The encrypted password is: 516b36fb8031da17cfbc010f7d09359c
Expand All @@ -49,16 +49,16 @@ db.password.encrypted=516b36fb8031da17cfbc010f7d09359c
After receiving your encrypted password, paste the password into the properties file and start the Failover Manager service. If there's a problem with the encrypted password, the Failover Manager service doesn't start:

```text
[witness@localhost ~]# systemctl start edb-efm-4.6
Job for edb-efm-4.6.service failed because the control process exited with error code. See "systemctl status edb-efm-4.6.service" and "journalctl -xe" for details.
[witness@localhost ~]# systemctl start edb-efm-4.7
Job for edb-efm-4.7.service failed because the control process exited with error code. See "systemctl status edb-efm-4.7.service" and "journalctl -xe" for details.
```

If you receive this message when starting the Failover Manager service, see the startup log `/var/log/efm-4.6/startup-efm.log` for more information.
If you receive this message when starting the Failover Manager service, see the startup log `/var/log/efm-4.7/startup-efm.log` for more information.

If you are using RHEL/CentOS 7.x or RHEL/Rocky Linux/AlmaLinux 8.x, startup information is also available with the following command:

```shell
systemctl status edb-efm-4.6
systemctl status edb-efm-4.7
```

To prevent a cluster from inadvertently connecting to the database of another cluster, the cluster name is incorporated into the encrypted password. If you modify the cluster name, you must re-encrypt the database password and update the cluster properties file.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Each node in a Failover Manager cluster has a cluster members file (by default n
After completing the Failover Manager installation, make a working copy of the template:

```shell
cp /etc/edb/efm-4.6/efm.nodes.in /etc/edb/efm-4.6/efm.nodes
cp /etc/edb/efm-4.7/efm.nodes.in /etc/edb/efm-4.7/efm.nodes
```

After copying the template file, change the owner of the file to efm:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,18 +36,18 @@ The `efm-42` file is located in `/etc/sudoers.d` and contains the following entr
# If you run your db service under a non-default account, you will need to copy
# this file to grant the proper permissions and specify the account in your efm
# cluster properties file by changing the 'db.service.owner' property.
efm ALL=(postgres) NOPASSWD: /usr/edb/efm-4.6/bin/efm_db_functions
efm ALL=(enterprisedb) NOPASSWD: /usr/edb/efm-4.6/bin/efm_db_functions
efm ALL=(postgres) NOPASSWD: /usr/edb/efm-4.7/bin/efm_db_functions
efm ALL=(enterprisedb) NOPASSWD: /usr/edb/efm-4.7/bin/efm_db_functions
# Allow user 'efm' to sudo efm_root_functions as 'root' to write/delete the PID file,
# validate the db.service.owner property, etc.
efm ALL=(ALL) NOPASSWD: /usr/edb/efm-4.6/bin/efm_root_functions
efm ALL=(ALL) NOPASSWD: /usr/edb/efm-4.7/bin/efm_root_functions
# Allow user 'efm' to sudo efm_address as root for VIP tasks.
efm ALL=(ALL) NOPASSWD: /usr/edb/efm-4.6/bin/efm_address
efm ALL=(ALL) NOPASSWD: /usr/edb/efm-4.7/bin/efm_address
# Allow user 'efm' to sudo efm_pgpool_functions as root for pgpool tasks.
efm ALL=(ALL) NOPASSWD: /usr/edb/efm-4.6/bin/efm_pgpool_functions
efm ALL=(ALL) NOPASSWD: /usr/edb/efm-4.7/bin/efm_pgpool_functions
# relax tty requirement for user 'efm'
Defaults:efm !requiretty
Expand Down Expand Up @@ -89,17 +89,17 @@ To run Failover Manager without sudo, you must select a database process owner w
```shell
su - enterprisedb

cp /etc/edb/efm-4.6/efm.properties.in <directory/cluster_name>.properties
cp /etc/edb/efm-4.7/efm.properties.in <directory/cluster_name>.properties

cp /etc/edb/efm-4.6/efm.nodes.in <directory>/<cluster_name>.nodes
cp /etc/edb/efm-4.7/efm.nodes.in <directory>/<cluster_name>.nodes
```

Then, modify the cluster properties file, providing the name of the user in the `db.service.owner` property. Also make sure that the `db.service.name` property is blank. Without sudo, you can't run services without root access.

After modifying the configuration, the new user can control Failover Manager with the following command:

```shell
/usr/edb/efm-4.6/bin/runefm.sh start|stop <directory/cluster_name>.properties
/usr/edb/efm-4.7/bin/runefm.sh start|stop <directory/cluster_name>.properties
```

Where `<directory/cluster_name.properties>` specifies the full path of the cluster properties file. The user provides the full path to the properties file whenever the nondefault user is controlling agents or using the `efm` script.
Expand Down
2 changes: 1 addition & 1 deletion product_docs/docs/efm/4/05_using_efm.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -282,7 +282,7 @@ Environment=CLUSTER=acctg
Also update the value of the `PIDfile` parameter to specify the new cluster name. For example:

```ini
PIDFile=/var/run/efm-4.6/acctg.pid
PIDFile=/var/run/efm-4.7/acctg.pid
```

After copying the service scripts, enable the services:
Expand Down
12 changes: 6 additions & 6 deletions product_docs/docs/efm/4/08_controlling_efm_service.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -40,12 +40,12 @@ Stop the Failover Manager on the current node. This command must be invoked by r
The `status` command returns the status of the Failover Manager agent on which it is invoked. You can invoke the status command on any node to instruct Failover Manager to return status and server startup information.

```text
[root@ONE ~]}> systemctl status edb-efm-4.6
edb-efm-4.6.service - EnterpriseDB Failover Manager 4.6
Loaded: loaded (/usr/lib/systemd/system/edb-efm-4.6.service; disabled; vendor preset: disabled)
[root@ONE ~]}> systemctl status edb-efm-4.7
edb-efm-4.7.service - EnterpriseDB Failover Manager 4.7
Loaded: loaded (/usr/lib/systemd/system/edb-efm-4.7.service; disabled; vendor preset: disabled)
Active: active (running) since Wed 2013-02-14 14:02:16 EST; 4s ago
Process: 58125 ExecStart=/bin/bash -c /usr/edb/edb-efm-4.6/bin/runefm.sh start ${CLUSTER} (code=exited, status=0/SUCCESS)
Process: 58125 ExecStart=/bin/bash -c /usr/edb/edb-efm-4.7/bin/runefm.sh start ${CLUSTER} (code=exited, status=0/SUCCESS)
Main PID: 58180 (java)
CGroup: /system.slice/edb-efm-4.6.service
└─58180 /usr/lib/jvm/java-1.8.0-openjdk-1.8.0.161-0.b14.el7_4.x86_64/jre/bin/java -cp /usr/edb/edb-efm-4.6/lib/EFM-4.6.jar -Xmx128m...
CGroup: /system.slice/edb-efm-4.7.service
└─58180 /usr/lib/jvm/java-1.8.0-openjdk-1.8.0.161-0.b14.el7_4.x86_64/jre/bin/java -cp /usr/edb/edb-efm-4.7/lib/EFM-4.7.jar -Xmx128m...
```
18 changes: 9 additions & 9 deletions product_docs/docs/efm/4/efm_quick_start/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Start the configuration process on a primary or standby node. Then, copy the con
1. Create working configuration files. Copy the provided sample files to create Failover Manager configuration files, and correct the ownership and version number if you are installing a different version:

```shell
cd /etc/edb/efm-4.6
cd /etc/edb/efm-4.7

cp efm.properties.in efm.properties

Expand All @@ -45,7 +45,7 @@ Start the configuration process on a primary or standby node. Then, copy the con
1. Create an [encrypted password](/efm/latest/04_configuring_efm/02_encrypting_database_password/) needed for the properties file:

```shell
/usr/edb/efm-4.6/bin/efm encrypt efm
/usr/edb/efm-4.7/bin/efm encrypt efm
```

Follow the onscreen instructions to produce the encrypted version of your database password.
Expand Down Expand Up @@ -83,38 +83,38 @@ Start the configuration process on a primary or standby node. Then, copy the con

The Failover Manager agent doesn't validate the addresses in the `efm.nodes` file. The agent expects that some of the addresses in the file can't be reached (for example, that another agent hasn’t been started yet).

1. Configure the other nodes. Copy the `efm.properties` and `efm.nodes` files to `/etc/edb/efm-4.6` on the other nodes in your sample cluster. After copying the files, change the file ownership so the files are owned by efm:efm. The `efm.properties` file can be the same on every node, except for the following properties:
1. Configure the other nodes. Copy the `efm.properties` and `efm.nodes` files to `/etc/edb/efm-4.7` on the other nodes in your sample cluster. After copying the files, change the file ownership so the files are owned by efm:efm. The `efm.properties` file can be the same on every node, except for the following properties:

- Modify the `bind.address` property to use the node’s local address.

- Set `is.witness` to `true` if the node is a witness node. If the node is a witness node, the properties relating to a local database installation are ignored.

1. Start the Failover Manager cluster. On any node, start the Failover Manager agent. The agent is named `edb-efm-4.6`; you can use your platform-specific service command to control the service. For example, on a RHEL 7.x or Rocky Linux/AlmaLinux/RHEL 8.x host, use the command:
1. Start the Failover Manager cluster. On any node, start the Failover Manager agent. The agent is named `edb-efm-4.7`; you can use your platform-specific service command to control the service. For example, on a RHEL 7.x or Rocky Linux/AlmaLinux/RHEL 8.x host, use the command:

```shell
systemctl start edb-efm-4.6
systemctl start edb-efm-4.7
```

1. After the agent starts, run the following command to see the status of the single-node cluster. The addresses of the other nodes appear in the `Allowed node host` list.

```shell
/usr/edb/efm-4.6/bin/efm cluster-status efm
/usr/edb/efm-4.7/bin/efm cluster-status efm
```

1. Start the agent on the other nodes. Run the `efm cluster-status efm` command on any node to see the cluster status.

If any agent fails to start, see the startup log for information about what went wrong:

```shell
cat /var/log/efm-4.6/startup-efm.log
cat /var/log/efm-4.7/startup-efm.log
```

## Perform a switchover

If the cluster status output shows that the primary and standby nodes are in sync, you can perform a switchover:

```shell
/usr/edb/efm-4.6/bin/efm promote efm -switchover
/usr/edb/efm-4.7/bin/efm promote efm -switchover
```

The command promotes a standby and reconfigures the primary database as a new standby in the cluster. To switch back, run the command again.
Expand All @@ -124,5 +124,5 @@ The command promotes a standby and reconfigures the primary database as a new st
For quick access to online help, use:

```shell
/usr/edb/efm-4.6/bin/efm --help
/usr/edb/efm-4.7/bin/efm --help
```
11 changes: 11 additions & 0 deletions product_docs/docs/efm/4/efm_rel_notes/03_efm_47_rel_notes.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: "Version 4.7"
---

Enhancements, bug fixes, and other changes in EFM 4.7 include:

| Type | Description |
| ---- |------------ |
| Enhancement | Failover Manager now only keeps one backup of pg_wal on standby when reconfiguring to follow a new primary. [Support tickets: #1277862, #91506] |
| Bug Fix | Fixed an issue where the Failover Manager startup script didn't work in locales that use commas for decimals; for example, "1,8". [Support ticket #89616]|
| Bug Fix | Fixed an issue where Failover Manager mistakenly used a standby's WAL receive value for replay value in the 'efm' command in Failover Manager 4.6. |
1 change: 1 addition & 0 deletions product_docs/docs/efm/4/efm_rel_notes/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ about the release that introduced the feature.

| Version | Release Date |
| ------- | ------------ |
| [4.7](03_efm_47_rel_notes) | 2023 Jun 20 |
| [4.6](04_efm_46_rel_notes) | 2023 Feb 14 |
| [4.5](05_efm_45_rel_notes) | 2022 Aug 30 |
| [4.4](06_efm_44_rel_notes) | 2022 Jan 5 |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Before you begin the installation process:
sudo dnf -y install edb-efm<4x>
```

Where `<4x>` is the version of Failover Manager that you are installing. For example, if you are installing version 4.6, the package name would be `edb-efm46`.
Where `<4x>` is the version of Failover Manager that you are installing. For example, if you are installing version 4.7, the package name would be `edb-efm47`.

The installation process creates a user named efm that has privileges to invoke scripts that control the Failover Manager service for clusters owned by enterprisedb or postgres.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Before you begin the installation process:
sudo zypper -n install edb-efm<4x>
```

Where `<4x>` is the version of Failover Manager that you are installing. For example, if you are installing version 4.6, the package name would be `edb-efm46`.
Where `<4x>` is the version of Failover Manager that you are installing. For example, if you are installing version 4.7, the package name would be `edb-efm47`.

The installation process creates a user named efm that has privileges to invoke scripts that control the Failover Manager service for clusters owned by enterprisedb or postgres.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Before you begin the installation process:
sudo zypper -n install edb-efm<4x>
```

Where `<4x>` is the version of Failover Manager that you are installing. For example, if you are installing version 4.6, the package name would be `edb-efm46`.
Where `<4x>` is the version of Failover Manager that you are installing. For example, if you are installing version 4.7, the package name would be `edb-efm47`.

The installation process creates a user named efm that has privileges to invoke scripts that control the Failover Manager service for clusters owned by enterprisedb or postgres.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Before you begin the installation process:
sudo yum -y install edb-efm<4x>
```

Where `<4x>` is the version of Failover Manager that you are installing. For example, if you are installing version 4.6, the package name would be `edb-efm46`.
Where `<4x>` is the version of Failover Manager that you are installing. For example, if you are installing version 4.7, the package name would be `edb-efm47`.

The installation process creates a user named efm that has privileges to invoke scripts that control the Failover Manager service for clusters owned by enterprisedb or postgres.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Before you begin the installation process:
sudo apt-get -y install edb-efm<4x>
```

Where `<4x>` is the version of Failover Manager that you are installing. For example, if you are installing version 4.6, the package name would be `edb-efm46`.
Where `<4x>` is the version of Failover Manager that you are installing. For example, if you are installing version 4.7, the package name would be `edb-efm47`.

The installation process creates a user named efm that has privileges to invoke scripts that control the Failover Manager service for clusters owned by enterprisedb or postgres.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Before you begin the installation process:
sudo apt-get -y install edb-efm<4x>
```

Where `<4x>` is the version of Failover Manager that you are installing. For example, if you are installing version 4.6, the package name would be `edb-efm46`.
Where `<4x>` is the version of Failover Manager that you are installing. For example, if you are installing version 4.7, the package name would be `edb-efm47`.

The installation process creates a user named efm that has privileges to invoke scripts that control the Failover Manager service for clusters owned by enterprisedb or postgres.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Before you begin the installation process:
sudo dnf -y install edb-efm<4x>
```

Where `<4x>` is the version of Failover Manager that you are installing. For example, if you are installing version 4.6, the package name would be `edb-efm46`.
Where `<4x>` is the version of Failover Manager that you are installing. For example, if you are installing version 4.7, the package name would be `edb-efm47`.

The installation process creates a user named efm that has privileges to invoke scripts that control the Failover Manager service for clusters owned by enterprisedb or postgres.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Before you begin the installation process:
sudo yum -y install edb-efm<4x>
```

Where `<4x>` is the version of Failover Manager that you are installing. For example, if you are installing version 4.6, the package name would be `edb-efm46`.
Where `<4x>` is the version of Failover Manager that you are installing. For example, if you are installing version 4.7, the package name would be `edb-efm47`.

The installation process creates a user named efm that has privileges to invoke scripts that control the Failover Manager service for clusters owned by enterprisedb or postgres.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Before you begin the installation process:
sudo dnf -y install edb-efm<4x>
```

Where `<4x>` is the version of Failover Manager that you are installing. For example, if you are installing version 4.6, the package name would be `edb-efm46`.
Where `<4x>` is the version of Failover Manager that you are installing. For example, if you are installing version 4.7, the package name would be `edb-efm47`.

The installation process creates a user named efm that has privileges to invoke scripts that control the Failover Manager service for clusters owned by enterprisedb or postgres.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Before you begin the installation process:
sudo zypper -n install edb-efm<4x>
```

Where `<4x>` is the version of Failover Manager that you are installing. For example, if you are installing version 4.6, the package name would be `edb-efm46`.
Where `<4x>` is the version of Failover Manager that you are installing. For example, if you are installing version 4.7, the package name would be `edb-efm47`.

The installation process creates a user named efm that has privileges to invoke scripts that control the Failover Manager service for clusters owned by enterprisedb or postgres.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Before you begin the installation process:
sudo zypper -n install edb-efm<4x>
```

Where `<4x>` is the version of Failover Manager that you are installing. For example, if you are installing version 4.6, the package name would be `edb-efm46`.
Where `<4x>` is the version of Failover Manager that you are installing. For example, if you are installing version 4.7, the package name would be `edb-efm47`.

The installation process creates a user named efm that has privileges to invoke scripts that control the Failover Manager service for clusters owned by enterprisedb or postgres.

Expand Down
Loading

2 comments on commit a39f9fa

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

πŸŽ‰ Published on https://edb-docs.netlify.app as production
πŸš€ Deployed on https://6492170fd3d36203fc80d9bc--edb-docs.netlify.app

Please sign in to comment.