From 5a48914ad9d915975fbd3b08a40151542f7d8a8f Mon Sep 17 00:00:00 2001 From: Jason Stephenson Date: Thu, 16 Dec 2021 14:04:58 -0500 Subject: [PATCH] LP1937294: Update Installation Documentation Update the server installation and upgrade documents to reflect the status of the newer PostgreSQL version and removal of PostgreSQL version 9.6. Signed-off-by: Jason Stephenson Signed-off-by: Mike Rylander --- .../installation/pages/server_installation.adoc | 91 ++++++++++++++++------ .../modules/installation/pages/server_upgrade.adoc | 2 +- 2 files changed, 70 insertions(+), 23 deletions(-) diff --git a/docs/modules/installation/pages/server_installation.adoc b/docs/modules/installation/pages/server_installation.adoc index 05e16649a3..259910b9b4 100644 --- a/docs/modules/installation/pages/server_installation.adoc +++ b/docs/modules/installation/pages/server_installation.adoc @@ -49,7 +49,7 @@ autoreconf -i == Installing prerequisites == - * **PostgreSQL**: The minimum supported version is 9.6. + * **PostgreSQL**: The minimum supported version is 10. * **Linux**: Evergreen has been tested on Debian Bullseye (11), Debian Buster (10), @@ -421,30 +421,22 @@ xref:admin:actiontriggers_process.adoc#processing_action_triggers[Notifications For production use, most libraries install the PostgreSQL database server on a dedicated machine. Therefore, by default, the `Makefile.install` prerequisite -installer does *not* install the PostgreSQL 9 database server that is required +installer does *not* install the PostgreSQL database server that is required by every Evergreen system. You can install the packages required by Debian or Ubuntu on the machine of your choice using the following commands as the *root* Linux account: . Installing PostgreSQL server packages -Each OS build target provides the postgres server installation packages -required for each operating system. To install Postgres server packages, -use the make target 'postgres-server-'. Choose the most appropriate -command below based on your operating system. This will install PostgreSQL 9.6, -the minimum supported version. +Each OS build target provides the postgres server installation +packages required for each operating system. To install Postgres +server packages, use the make target +'postgres-server--'. Choose the most +appropriate command below based on your operating system and desired +PostgreSQL Version. -[source, bash] ------------------------------------------------------------------------------- -make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-bullseye -make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-buster -make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-stretch -make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-bionic -make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-focal ------------------------------------------------------------------------------- - -To install PostgreSQL version 10, use the following command for your operating -system: +The first below will install PostgreSQL 10, the minimum supported +version and the version recommended for production use of Evergreen: [source, bash] ------------------------------------------------------------------------------ @@ -455,6 +447,63 @@ make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-bionic-10 make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-focal-10 ------------------------------------------------------------------------------ +[WARNING] +========= +Evergreen support for PostgreSQL server versions greater than 10 is +still exprimental. The use of the following is discouraged in +production environments. The following are only recommended if you +are willing to test newer PostgreSQL versions for performance and +possible bugs. +========= + +To install PostgreSQL version 11, use the following command for your operating +system: + +[source, bash] +------------------------------------------------------------------------------ +make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-bullseye-11 +make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-buster-11 +make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-stretch-11 +make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-bionic-11 +make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-focal-11 +------------------------------------------------------------------------------ + +To install PostgreSQL version 12, use the following command for your operating +system: + +[source, bash] +------------------------------------------------------------------------------ +make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-bullseye-12 +make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-buster-12 +make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-stretch-12 +make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-bionic-12 +make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-focal-12 +------------------------------------------------------------------------------ + +To install PostgreSQL version 13, use the following command for your operating +system: + +[source, bash] +------------------------------------------------------------------------------ +make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-bullseye-13 +make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-buster-13 +make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-stretch-13 +make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-bionic-13 +make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-focal-13 +------------------------------------------------------------------------------ + +To install PostgreSQL version 14, use the following command for your operating +system: + +[source, bash] +------------------------------------------------------------------------------ +make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-bullseye-14 +make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-buster-14 +make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-stretch-14 +make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-bionic-14 +make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-focal-14 +------------------------------------------------------------------------------ + For a standalone PostgreSQL server, install the following Perl modules for your distribution as the *root* Linux account: @@ -536,10 +585,8 @@ own copy of the _concerto_ sample data. In a production instance of Evergreen, your PostgreSQL server should be installed on a dedicated server. -==== PostgreSQL 9.6 and later ==== - -To create the database instance on a remote database server running PostgreSQL -9.6 or later, simply use the `--create-database` flag on `eg_db_config`. +To create the database instance on a remote database server, simply +use the `--create-database` flag on `eg_db_config`. == Starting Evergreen == diff --git a/docs/modules/installation/pages/server_upgrade.adoc b/docs/modules/installation/pages/server_upgrade.adoc index 3535d522e8..27d501a0cf 100644 --- a/docs/modules/installation/pages/server_upgrade.adoc +++ b/docs/modules/installation/pages/server_upgrade.adoc @@ -6,7 +6,7 @@ All of the steps in this chapter are to be completed from the command line. == Software Prerequisites == - * **PostgreSQL**: The minimum supported version is 9.6. + * **PostgreSQL**: The minimum supported version is 10. * **Linux**: Evergreen 3.X.X has been tested on Debian Stretch (9.0), Debian Buster (10.0), Debian Bullseye (11.0), Ubuntu Bionic Beaver (18.04), and Ubuntu Focal Fossa (20.04). If you -- 2.11.0