From e1c5b719dd5a7d2acfe738fbd025a997f5cb897c Mon Sep 17 00:00:00 2001 From: nidhibhammar <59045594+nidhibhammar@users.noreply.github.com> Date: Tue, 26 Jul 2022 10:07:02 +0530 Subject: [PATCH 01/16] PEM - Redhat install topics --- install_template/config.yaml | 6 ------ .../templates/platformBase/redhat-family.njk | 4 ++-- .../almalinux-8-or-rocky-linux-8.njk | 2 ++ .../rhel-7_ppc64le.njk | 2 -- .../almalinux-8-or-rocky-linux-8.njk | 10 +--------- .../postgres-enterprise-manager-server/base.njk | 2 +- .../rhel-7_ppc64le.njk | 2 -- 7 files changed, 6 insertions(+), 22 deletions(-) create mode 100644 install_template/templates/products/postgres-enterprise-manager-agent/almalinux-8-or-rocky-linux-8.njk delete mode 100644 install_template/templates/products/postgres-enterprise-manager-agent/rhel-7_ppc64le.njk delete mode 100644 install_template/templates/products/postgres-enterprise-manager-server/rhel-7_ppc64le.njk diff --git a/install_template/config.yaml b/install_template/config.yaml index 8be624b1213..adcdc72b2ff 100644 --- a/install_template/config.yaml +++ b/install_template/config.yaml @@ -593,9 +593,6 @@ products: - name: Ubuntu 18.04 arch: x86_64 supported versions: [8] - - name: Ubuntu 18.04 - arch: x86_64 - supported versions: [8] - name: Ubuntu 20.04 arch: x86_64 supported versions: [8] @@ -640,9 +637,6 @@ products: - name: Ubuntu 18.04 arch: x86_64 supported versions: [8] - - name: Ubuntu 18.04 - arch: x86_64 - supported versions: [8] - name: Ubuntu 20.04 arch: x86_64 supported versions: [8] diff --git a/install_template/templates/platformBase/redhat-family.njk b/install_template/templates/platformBase/redhat-family.njk index 3f55d84adba..b990b7fb2b9 100644 --- a/install_template/templates/platformBase/redhat-family.njk +++ b/install_template/templates/platformBase/redhat-family.njk @@ -7,14 +7,14 @@ # Replace '' and '' below with # your username and password for the EDB repository: sed -i "s@:@USERNAME:PASSWORD@" /etc/yum.repos.d/edb.repo - +{% block pemsetuprepo %} # Install the EPEL repository: {{ packageManager }} -y install {{ epelRepo }} {% if includePPC %} # Refresh the cache: dnf makecache {% endif %} -{% block redhatConfig %}{% endblock redhatConfig %} +{% block redhatConfig %}{% endblock redhatConfig %}{% endblock pemsetuprepo %} ``` {% endblock prerequisites %} {% block installCommand %} diff --git a/install_template/templates/products/postgres-enterprise-manager-agent/almalinux-8-or-rocky-linux-8.njk b/install_template/templates/products/postgres-enterprise-manager-agent/almalinux-8-or-rocky-linux-8.njk new file mode 100644 index 00000000000..371223e7df7 --- /dev/null +++ b/install_template/templates/products/postgres-enterprise-manager-agent/almalinux-8-or-rocky-linux-8.njk @@ -0,0 +1,2 @@ +{% extends "products/postgres-enterprise-manager-agent/base.njk" %} +{% set platformBaseTemplate = "almalinux-8-or-rocky-linux-8" %} \ No newline at end of file diff --git a/install_template/templates/products/postgres-enterprise-manager-agent/rhel-7_ppc64le.njk b/install_template/templates/products/postgres-enterprise-manager-agent/rhel-7_ppc64le.njk deleted file mode 100644 index 19ae7b153f5..00000000000 --- a/install_template/templates/products/postgres-enterprise-manager-agent/rhel-7_ppc64le.njk +++ /dev/null @@ -1,2 +0,0 @@ -{% extends "products/postgres-enterprise-manager-agent/rhel-7-or-ol-7.njk" %} -{% set includePPC = true %} \ No newline at end of file diff --git a/install_template/templates/products/postgres-enterprise-manager-server/almalinux-8-or-rocky-linux-8.njk b/install_template/templates/products/postgres-enterprise-manager-server/almalinux-8-or-rocky-linux-8.njk index 7976068b9ec..2def22fe2cb 100644 --- a/install_template/templates/products/postgres-enterprise-manager-server/almalinux-8-or-rocky-linux-8.njk +++ b/install_template/templates/products/postgres-enterprise-manager-server/almalinux-8-or-rocky-linux-8.njk @@ -1,10 +1,2 @@ {% extends "products/postgres-enterprise-manager-server/base.njk" %} -{% set platformBaseTemplate = "almalinux-8-or-rocky-linux-8" %} -{% block prerequisites %} -{{ super() }} -1. Disable the built-in PostgreSQL module: - - ```sh - dnf -qy module disable postgresql - ``` -{% endblock prerequisites %} \ No newline at end of file +{% set platformBaseTemplate = "almalinux-8-or-rocky-linux-8" %} \ No newline at end of file diff --git a/install_template/templates/products/postgres-enterprise-manager-server/base.njk b/install_template/templates/products/postgres-enterprise-manager-server/base.njk index 39fba1b2858..79487f50ef3 100644 --- a/install_template/templates/products/postgres-enterprise-manager-server/base.njk +++ b/install_template/templates/products/postgres-enterprise-manager-server/base.njk @@ -9,7 +9,7 @@ Before you begin the installation process: sudo su - ``` {% endblock pemprereq %} -{% block postinstallMenu %}- [Performing the initial configuration](#initial-configuration){% endblock postinstallMenu %} +{% block pemsetuprepo %}{% endblock pemsetuprepo %} {% block postinstall %} ## Initial configuration diff --git a/install_template/templates/products/postgres-enterprise-manager-server/rhel-7_ppc64le.njk b/install_template/templates/products/postgres-enterprise-manager-server/rhel-7_ppc64le.njk deleted file mode 100644 index 839301511ac..00000000000 --- a/install_template/templates/products/postgres-enterprise-manager-server/rhel-7_ppc64le.njk +++ /dev/null @@ -1,2 +0,0 @@ -{% extends "products/postgres-enterprise-manager-server/rhel-7-or-ol-7.njk" %} -{% set includePPC = true %} \ No newline at end of file From fa5aa10217a01bc73fb5b77eec1261fb3d96abba Mon Sep 17 00:00:00 2001 From: David Wicinas <93669463+dwicinas@users.noreply.github.com> Date: Thu, 4 Aug 2022 10:49:01 -0400 Subject: [PATCH 02/16] Template changes and generated changes for Hadoop --- install_template/config.yaml | 6 +- install_template/deploy.mjs | 10 +++ .../almalinux-8-or-rocky-linux-8.njk | 10 +-- .../rhel-8-or-ol-8.njk | 7 +- .../rhel-8_ppc64le.njk | 2 +- .../ibm_power_ppc64le/hadoop_rhel8_ppcle.mdx | 71 +++++++------------ .../x86_amd64/hadoop_centos7_x86.mdx | 45 +++++++----- .../x86_amd64/hadoop_other_linux8_x86.mdx | 57 ++++++++------- .../x86_amd64/hadoop_rhel7_x86.mdx | 48 +++++++------ .../x86_amd64/hadoop_rhel8_x86.mdx | 57 ++++++++------- 10 files changed, 152 insertions(+), 161 deletions(-) rename install_template/templates/products/{failover-manager => hadoop-foreign-data-wrapper}/rhel-8_ppc64le.njk (55%) diff --git a/install_template/config.yaml b/install_template/config.yaml index 0eecc966098..5f013b38820 100644 --- a/install_template/config.yaml +++ b/install_template/config.yaml @@ -408,9 +408,6 @@ products: - name: CentOS 7 arch: x86_64 supported versions: [2] - - name: CentOS 7 - arch: ppc64le - supported versions: [2] - name: AlmaLinux 8 or Rocky Linux 8 arch: x86_64 supported versions: [2] @@ -420,6 +417,9 @@ products: - name: RHEL 8 or OL 8 arch: x86_64 supported versions: [2] + - name: RHEL 8 + arch: ppc64le + supported versions: [2] - name: Ubuntu 18.04 arch: x86_64 supported versions: [2] diff --git a/install_template/deploy.mjs b/install_template/deploy.mjs index 2c74cebaa8b..46566af428b 100644 --- a/install_template/deploy.mjs +++ b/install_template/deploy.mjs @@ -202,6 +202,16 @@ const moveDoc = async (product, platform, version) => { (ctx) => `hadoop_data_adapter/2/05_installing_the_hadoop_data_adapter/${fmtArchPath(ctx)}/hadoop_ubuntu18_${fmtArchFilename(ctx)}.mdx`), when({product: {name: "Hadoop Foreign Data Wrapper", version: 2}, platform: {name: "Debian 10"}}, (ctx) => `hadoop_data_adapter/2/05_installing_the_hadoop_data_adapter/${fmtArchPath(ctx)}/hadoop_deb10_${fmtArchFilename(ctx)}.mdx`), + when({product: {name: "Hadoop Foreign Data Wrapper", version: 2}, platform: {name: "CentOS 7"}}, + (ctx) => `hadoop_data_adapter/2/05_installing_the_hadoop_data_adapter/${fmtArchPath(ctx)}/hadoop_centos7_${fmtArchFilename(ctx)}.mdx`), + when({product: {name: "Hadoop Foreign Data Wrapper", version: 2}, platform: {name: "AlmaLinux 8 or Rocky Linux 8"}}, + (ctx) => `hadoop_data_adapter/2/05_installing_the_hadoop_data_adapter/${fmtArchPath(ctx)}/hadoop_other_linux8_${fmtArchFilename(ctx)}.mdx`), + when({product: {name: "Hadoop Foreign Data Wrapper", version: 2}, platform: {name: "RHEL 7 or OL 7"}}, + (ctx) => `hadoop_data_adapter/2/05_installing_the_hadoop_data_adapter/${fmtArchPath(ctx)}/hadoop_rhel7_${fmtArchFilename(ctx)}.mdx`), + when({product: {name: "Hadoop Foreign Data Wrapper", version: 2}, platform: {name: "RHEL 8 or OL 8"}}, + (ctx) => `hadoop_data_adapter/2/05_installing_the_hadoop_data_adapter/${fmtArchPath(ctx)}/hadoop_rhel8_${fmtArchFilename(ctx)}.mdx`), + when({product: {name: "Hadoop Foreign Data Wrapper", version: 2}, platform: {name: "RHEL 8"}}, + (ctx) => `hadoop_data_adapter/2/05_installing_the_hadoop_data_adapter/${fmtArchPath(ctx)}/hadoop_rhel8_${fmtArchFilename(ctx)}.mdx`), when({product: {name: "EDB JDBC Connector"}, platform: {name: "SLES 12"}}, (ctx) => `jdbc_connector/42.3.3.1/04_installing_and_configuring_the_jdbc_connector/01_installing_the_connector_with_an_rpm_package/${fmtArchPath(ctx)}/jdbc42_sles12_${fmtArchFilename(ctx)}.mdx`), when({product: {name: "EDB JDBC Connector"}, platform: {name: "SLES 15"}}, diff --git a/install_template/templates/products/hadoop-foreign-data-wrapper/almalinux-8-or-rocky-linux-8.njk b/install_template/templates/products/hadoop-foreign-data-wrapper/almalinux-8-or-rocky-linux-8.njk index 7aa6155aa47..1f162e832fe 100644 --- a/install_template/templates/products/hadoop-foreign-data-wrapper/almalinux-8-or-rocky-linux-8.njk +++ b/install_template/templates/products/hadoop-foreign-data-wrapper/almalinux-8-or-rocky-linux-8.njk @@ -1,10 +1,2 @@ {% extends "products/hadoop-foreign-data-wrapper/base.njk" %} -{% set platformBaseTemplate = "almalinux-8-or-rocky-linux-8" %} -{% block prerequisites %} -{{ super() }} -1. Disable the built-in PostgreSQL module: - - ```sh - dnf -qy module disable postgresql - ``` -{% endblock prerequisites %} \ No newline at end of file +{% set platformBaseTemplate = "almalinux-8-or-rocky-linux-8" %} \ No newline at end of file diff --git a/install_template/templates/products/hadoop-foreign-data-wrapper/rhel-8-or-ol-8.njk b/install_template/templates/products/hadoop-foreign-data-wrapper/rhel-8-or-ol-8.njk index c19c16f990d..813444b77e2 100644 --- a/install_template/templates/products/hadoop-foreign-data-wrapper/rhel-8-or-ol-8.njk +++ b/install_template/templates/products/hadoop-foreign-data-wrapper/rhel-8-or-ol-8.njk @@ -1,2 +1,7 @@ {% extends "products/hadoop-foreign-data-wrapper/base.njk" %} -{% set platformBaseTemplate = "rhel-8-or-ol-8" %} \ No newline at end of file +{% set platformBaseTemplate = "rhel-8-or-ol-8" %} +{% block redhatConfig %}# Enable additional repositories to resolve dependencies: +dnf config-manager --set-enabled PowerTools + +# Disable the built-in PostgreSQL module: +dnf -qy module disable postgresql{% endblock redhatConfig %} \ No newline at end of file diff --git a/install_template/templates/products/failover-manager/rhel-8_ppc64le.njk b/install_template/templates/products/hadoop-foreign-data-wrapper/rhel-8_ppc64le.njk similarity index 55% rename from install_template/templates/products/failover-manager/rhel-8_ppc64le.njk rename to install_template/templates/products/hadoop-foreign-data-wrapper/rhel-8_ppc64le.njk index 14330fef043..62d4472fe13 100644 --- a/install_template/templates/products/failover-manager/rhel-8_ppc64le.njk +++ b/install_template/templates/products/hadoop-foreign-data-wrapper/rhel-8_ppc64le.njk @@ -1,3 +1,3 @@ -{% extends "products/failover-manager/base.njk" %} +{% extends "products/hadoop-foreign-data-wrapper/base.njk" %} {% set platformBaseTemplate = "rhel-8-or-ol-8" %} {% set includePPC = true %} diff --git a/product_docs/docs/hadoop_data_adapter/2/05_installing_the_hadoop_data_adapter/ibm_power_ppc64le/hadoop_rhel8_ppcle.mdx b/product_docs/docs/hadoop_data_adapter/2/05_installing_the_hadoop_data_adapter/ibm_power_ppc64le/hadoop_rhel8_ppcle.mdx index c42ee9ae186..0f6af2cd5bb 100644 --- a/product_docs/docs/hadoop_data_adapter/2/05_installing_the_hadoop_data_adapter/ibm_power_ppc64le/hadoop_rhel8_ppcle.mdx +++ b/product_docs/docs/hadoop_data_adapter/2/05_installing_the_hadoop_data_adapter/ibm_power_ppc64le/hadoop_rhel8_ppcle.mdx @@ -1,67 +1,44 @@ --- -title: "Installing Hadoop Foreign Data Wrapper on RHEL 8 IBM Power (ppc64le)" -navTitle: "RHEL 8" +navTitle: RHEL 8 +title: Installing Hadoop Foreign Data Wrapper on RHEL 8 ppc64le --- -There are two steps to completing an installation: - -- Setting up the repository -- Installing the package - -For each step, you must be logged in as superuser. - -To log in as a superuser: +Before you begin the installation process, log in as superuser. ```shell +# To log in as a superuser: sudo su - ``` -## Setting up the repository - -1. To register with EDB to receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request). - -1. Set up the EDB repository: - - ```shell - dnf -y install https://yum.enterprisedb.com/edbrepos/edb-repo-latest.noarch.rpm - ``` +## Set up the repository - This creates the /etc/yum.repos.d/edb.repo configuration file. +Setting up the repository is a one-time task. If you have already set up your repository, you do not need to perform this step. If you do need to set up the repository, you must register with EDB. To receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request). -1. Add your EDB credentials to the edb.repo file: - - ```shell - sed -i "s@:@USERNAME:PASSWORD@" /etc/yum.repos.d/edb.repo - ``` - - where `USERNAME:PASSWORD` is the username and password available from your - [EDB account](https://www.enterprisedb.com/user). +```shell +# Set up the EDB repository: +dnf -y install https://yum.enterprisedb.com/edbrepos/edb-repo-latest.noarch.rpm -1. Install the EPEL repository and refresh the cache: +# Replace '' and '' below with +# your username and password for the EDB repository: +sed -i "s@:@USERNAME:PASSWORD@" /etc/yum.repos.d/edb.repo - ```shell - dnf -y install https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm - dnf makecache - ``` +# Install the EPEL repository: +dnf -y install https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm -1. Enable the codeready-builder-for-rhel-8-\*-rpms repository since EPEL packages may depend on packages from it: +# Refresh the cache: +dnf makecache - ```shell - ARCH=$( /bin/arch ) - subscription-manager repos --enable "codeready-builder-for-rhel-8-${ARCH}-rpms" - ``` +# Enable additional repositories to resolve dependencies: +ARCH=$( /bin/arch ) subscription-manager repos --enable "codeready-builder-for-rhel-8-${ARCH}-rpms" -1. Disable the built-in PostgreSQL module: - ```shell - dnf -qy module disable postgresql - ``` +# Disable the built-in PostgreSQL module: +dnf -qy module disable postgresql +``` -## Installing the package +## Install the package ```shell -dnf -y install edb-as-hdfs_fdw +dnf -y install edb-as14-hdfs_fdw ``` -where `xx` is the server version number. - - +Where `14` is the version of EDB Postgres Advanced Server. Replace `14` with the version of EDB Postgres Advanced Server you are using. diff --git a/product_docs/docs/hadoop_data_adapter/2/05_installing_the_hadoop_data_adapter/x86_amd64/hadoop_centos7_x86.mdx b/product_docs/docs/hadoop_data_adapter/2/05_installing_the_hadoop_data_adapter/x86_amd64/hadoop_centos7_x86.mdx index 20dc578a07b..dce6184082c 100644 --- a/product_docs/docs/hadoop_data_adapter/2/05_installing_the_hadoop_data_adapter/x86_amd64/hadoop_centos7_x86.mdx +++ b/product_docs/docs/hadoop_data_adapter/2/05_installing_the_hadoop_data_adapter/x86_amd64/hadoop_centos7_x86.mdx @@ -1,30 +1,37 @@ --- -title: "Installing Hadoop Foreign Data Wrapper on CentOS 7 x86" -navTitle: "CentOS 7" +navTitle: CentOS 7 +title: Installing Hadoop Foreign Data Wrapper on CentOS 7 x86_64 --- -1. To create the repository configuration file, assume superuser privileges, and invoke the following command: +Before you begin the installation process, log in as superuser. - ```text - yum -y install https://yum.enterprisedb.com/edbrepos/edb-repo-latest.noarch.rpm - ``` +```shell +# To log in as a superuser: +sudo su - +``` -2. Replace ‘USERNAME:PASSWORD’ below with your username and password for the EDB repositories: +## Set up the repository - ```text - sed -i "s@:@USERNAME:PASSWORD@" /etc/yum.repos.d/edb.repo - ``` +Setting up the repository is a one-time task. If you have already set up your repository, you do not need to perform this step. If you do need to set up the repository, you must register with EDB. To receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request). -3. Install the EPEL repository: +```shell +# Set up the EDB repository: +yum -y install https://yum.enterprisedb.com/edbrepos/edb-repo-latest.noarch.rpm - ```text - yum -y install https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm - ``` +# Replace '' and '' below with +# your username and password for the EDB repository: +sed -i "s@:@USERNAME:PASSWORD@" /etc/yum.repos.d/edb.repo -5. Install the selected package: +# Install the EPEL repository: +yum -y install https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm - ```text - dnf install edb-as-hdfs_fdw - ``` - where `xx` is the server version number. +``` + +## Install the package + +```shell +yum -y install edb-as14-hdfs_fdw +``` + +Where `14` is the version of EDB Postgres Advanced Server. Replace `14` with the version of EDB Postgres Advanced Server you are using. diff --git a/product_docs/docs/hadoop_data_adapter/2/05_installing_the_hadoop_data_adapter/x86_amd64/hadoop_other_linux8_x86.mdx b/product_docs/docs/hadoop_data_adapter/2/05_installing_the_hadoop_data_adapter/x86_amd64/hadoop_other_linux8_x86.mdx index 8a5afe2db79..4965f469783 100644 --- a/product_docs/docs/hadoop_data_adapter/2/05_installing_the_hadoop_data_adapter/x86_amd64/hadoop_other_linux8_x86.mdx +++ b/product_docs/docs/hadoop_data_adapter/2/05_installing_the_hadoop_data_adapter/x86_amd64/hadoop_other_linux8_x86.mdx @@ -1,42 +1,41 @@ --- -title: "Installing Hadoop Foreign Data Wrapper on Rocky Linux 8/AlmaLinux 8 x86" -navTitle: "Rocky Linux 8/AlmaLinux 8" +navTitle: AlmaLinux 8 or Rocky Linux 8 +title: Installing Hadoop Foreign Data Wrapper on AlmaLinux 8 or Rocky Linux 8 x86_64 --- -1. To create the repository configuration file, assume superuser privileges, and invoke the following command: - - ```text - dnf -y install https://yum.enterprisedb.com/edbrepos/edb-repo-latest.noarch.rpm - ``` +Before you begin the installation process, log in as superuser. -2. Replace ‘USERNAME:PASSWORD’ below with your username and password for the EDB repositories: +```shell +# To log in as a superuser: +sudo su - +``` - ```text - sed -i "s@:@USERNAME:PASSWORD@" /etc/yum.repos.d/edb.repo - ``` +## Set up the repository -3. Install the EPEL repository: +Setting up the repository is a one-time task. If you have already set up your repository, you do not need to perform this step. If you do need to set up the repository, you must register with EDB. To receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request). - ```text - dnf -y install epel-release - ``` +```shell +# Set up the EDB repository: +dnf -y install https://yum.enterprisedb.com/edbrepos/edb-repo-latest.noarch.rpm -4. Enable the additional repositories to resolve dependencies: +# Replace '' and '' below with +# your username and password for the EDB repository: +sed -i "s@:@USERNAME:PASSWORD@" /etc/yum.repos.d/edb.repo - ```text - dnf config-manager --set-enabled PowerTools - ``` +# Install the EPEL repository: +dnf -y install epel-release -5. Disable the built-in PostgreSQL module: +# Enable additional repositories to resolve dependencies: +dnf config-manager --set-enabled PowerTools - ```text - dnf -qy module disable postgresql - ``` -6. Install the selected package: - - ```text - dnf install edb-as-hdfs_fdw - ``` +# Disable the built-in PostgreSQL module: +dnf -qy module disable postgresql +``` - where `xx` is the server version number. +## Install the package +```shell +dnf -y install edb-as14-hdfs_fdw +``` + +Where `14` is the version of EDB Postgres Advanced Server. Replace `14` with the version of EDB Postgres Advanced Server you are using. diff --git a/product_docs/docs/hadoop_data_adapter/2/05_installing_the_hadoop_data_adapter/x86_amd64/hadoop_rhel7_x86.mdx b/product_docs/docs/hadoop_data_adapter/2/05_installing_the_hadoop_data_adapter/x86_amd64/hadoop_rhel7_x86.mdx index 56b636b5419..37d6884a244 100644 --- a/product_docs/docs/hadoop_data_adapter/2/05_installing_the_hadoop_data_adapter/x86_amd64/hadoop_rhel7_x86.mdx +++ b/product_docs/docs/hadoop_data_adapter/2/05_installing_the_hadoop_data_adapter/x86_amd64/hadoop_rhel7_x86.mdx @@ -1,36 +1,38 @@ --- -title: "Hadoop Foreign Data Wrapper on RHEL 7/OL 7 x86" -navTitle: "RHEL 7/OL 7 " +navTitle: RHEL 7 or OL 7 +title: Installing Hadoop Foreign Data Wrapper on RHEL 7 or OL 7 x86_64 --- -1. To create the repository configuration file, assume superuser privileges, and invoke the following command: +Before you begin the installation process, log in as superuser. - ```text - yum -y install https://yum.enterprisedb.com/edbrepos/edb-repo-latest.noarch.rpm - ``` +```shell +# To log in as a superuser: +sudo su - +``` -2. Replace ‘USERNAME:PASSWORD’ below with your username and password for the EDB repositories: +## Set up the repository - ```text - sed -i "s@:@USERNAME:PASSWORD@" /etc/yum.repos.d/edb.repo - ``` +Setting up the repository is a one-time task. If you have already set up your repository, you do not need to perform this step. If you do need to set up the repository, you must register with EDB. To receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request). -3. Install the EPEL repository: +```shell +# Set up the EDB repository: +yum -y install https://yum.enterprisedb.com/edbrepos/edb-repo-latest.noarch.rpm - ```text - yum -y install https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm - ``` +# Replace '' and '' below with +# your username and password for the EDB repository: +sed -i "s@:@USERNAME:PASSWORD@" /etc/yum.repos.d/edb.repo -4. Enable additional repositories to resolve dependencies: +# Install the EPEL repository: +yum -y install https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm - ```text - subscription-manager repos --enable "rhel-*-optional-rpms" --enable "rhel-*-extras-rpms" --enable "rhel-ha-for-rhel-*-server-rpms" - ``` +# Enable additional repositories to resolve dependencies: +subscription-manager repos --enable "rhel-*-optional-rpms" --enable "rhel-*-extras-rpms" --enable "rhel-ha-for-rhel-*-server-rpms" +``` -5. Install the selected package: +## Install the package - ```text - dnf install edb-as-hdfs_fdw - ``` +```shell +yum -y install edb-as14-hdfs_fdw +``` - where `xx` is the server version number. +Where `14` is the version of EDB Postgres Advanced Server. Replace `14` with the version of EDB Postgres Advanced Server you are using. diff --git a/product_docs/docs/hadoop_data_adapter/2/05_installing_the_hadoop_data_adapter/x86_amd64/hadoop_rhel8_x86.mdx b/product_docs/docs/hadoop_data_adapter/2/05_installing_the_hadoop_data_adapter/x86_amd64/hadoop_rhel8_x86.mdx index 5f32859801a..d9c29e9492d 100644 --- a/product_docs/docs/hadoop_data_adapter/2/05_installing_the_hadoop_data_adapter/x86_amd64/hadoop_rhel8_x86.mdx +++ b/product_docs/docs/hadoop_data_adapter/2/05_installing_the_hadoop_data_adapter/x86_amd64/hadoop_rhel8_x86.mdx @@ -1,42 +1,41 @@ --- -title: "Installing Hadoop Foreign Data Wrapper on RHEL 8/OL 8 x86" -navTitle: "RHEL 8/OL 8" +navTitle: RHEL 8 or OL 8 +title: Installing Hadoop Foreign Data Wrapper on RHEL 8 or OL 8 x86_64 --- -1. To create the repository configuration file, assume superuser privileges, and invoke the following command: - - ```text - dnf -y install https://yum.enterprisedb.com/edbrepos/edb-repo-latest.noarch.rpm - ``` +Before you begin the installation process, log in as superuser. -2. Replace ‘USERNAME:PASSWORD’ below with your username and password for the EDB repositories: +```shell +# To log in as a superuser: +sudo su - +``` - ```text - sed -i "s@:@USERNAME:PASSWORD@" /etc/yum.repos.d/edb.repo - ``` +## Set up the repository -3. Install the EPEL repository: +Setting up the repository is a one-time task. If you have already set up your repository, you do not need to perform this step. If you do need to set up the repository, you must register with EDB. To receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request). - ```text - dnf -y install https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm - ``` +```shell +# Set up the EDB repository: +dnf -y install https://yum.enterprisedb.com/edbrepos/edb-repo-latest.noarch.rpm -4. Enable the additional repositories to resolve dependencies: +# Replace '' and '' below with +# your username and password for the EDB repository: +sed -i "s@:@USERNAME:PASSWORD@" /etc/yum.repos.d/edb.repo - ```text - dnf config-manager --set-enabled PowerTools - ``` +# Install the EPEL repository: +dnf -y install https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm -5. Disable the built-in PostgreSQL module: +# Enable additional repositories to resolve dependencies: +dnf config-manager --set-enabled PowerTools - ```text - dnf -qy module disable postgresql - ``` -6. Install the selected package: - - ```text - dnf install edb-as-hdfs_fdw - ``` +# Disable the built-in PostgreSQL module: +dnf -qy module disable postgresql +``` - where `xx` is the server version number. +## Install the package +```shell +dnf -y install edb-as14-hdfs_fdw +``` + +Where `14` is the version of EDB Postgres Advanced Server. Replace `14` with the version of EDB Postgres Advanced Server you are using. From 65e153a1ae520d3819fbd3d645f3e9ec1c2f8f8b Mon Sep 17 00:00:00 2001 From: David Wicinas <93669463+dwicinas@users.noreply.github.com> Date: Thu, 4 Aug 2022 11:24:24 -0400 Subject: [PATCH 03/16] template changes and generated changes for MongoDB --- install_template/config.yaml | 7 +- install_template/deploy.mjs | 10 +++ .../almalinux-8-or-rocky-linux-8.njk | 10 +-- .../rhel-8_ppc64le.njk | 3 + .../ibm_power_ppc64le/mongo_rhel8_ppcle.mdx | 70 +++++++------------ .../x86_amd64/mongo_centos7_x86.mdx | 46 ++++++------ .../x86_amd64/mongo_other_linux8_x86.mdx | 57 ++++++++------- .../x86_amd64/mongo_rhel7_x86.mdx | 49 ++++++------- .../x86_amd64/mongo_rhel8_x86.mdx | 58 +++++++-------- 9 files changed, 148 insertions(+), 162 deletions(-) create mode 100644 install_template/templates/products/mongodb-foreign-data-wrapper/rhel-8_ppc64le.njk diff --git a/install_template/config.yaml b/install_template/config.yaml index 5f013b38820..2a0c4b038cf 100644 --- a/install_template/config.yaml +++ b/install_template/config.yaml @@ -449,9 +449,6 @@ products: - name: CentOS 7 arch: x86_64 supported versions: [5] - - name: CentOS 7 - arch: ppc64le - supported versions: [5] - name: AlmaLinux 8 or Rocky Linux 8 arch: x86_64 supported versions: [5] @@ -461,8 +458,8 @@ products: - name: RHEL 8 or OL 8 arch: x86_64 supported versions: [5] - - name: Debian 9 - arch: x86_64 + - name: RHEL 8 + arch: ppc64le supported versions: [5] - name: Debian 10 arch: x86_64 diff --git a/install_template/deploy.mjs b/install_template/deploy.mjs index 46566af428b..1f7b31a3c1e 100644 --- a/install_template/deploy.mjs +++ b/install_template/deploy.mjs @@ -242,6 +242,16 @@ const moveDoc = async (product, platform, version) => { (ctx) => `mongo_data_adapter/5/04_installing_the_mongo_data_adapter/${fmtArchPath(ctx)}/mongo_ubuntu18_${fmtArchFilename(ctx)}.mdx`), when({product: {name: "MongoDB Foreign Data Wrapper", version: 5}, platform: {name: "Debian 10"}}, (ctx) => `mongo_data_adapter/5/04_installing_the_mongo_data_adapter/${fmtArchPath(ctx)}/mongo_deb10_${fmtArchFilename(ctx)}.mdx`), + when({product: {name: "MongoDB Foreign Data Wrapper", version: 5}, platform: {name: "CentOS 7"}}, + (ctx) => `mongo_data_adapter/5/04_installing_the_mongo_data_adapter/${fmtArchPath(ctx)}/mongo_centos7_${fmtArchFilename(ctx)}.mdx`), + when({product: {name: "MongoDB Foreign Data Wrapper", version: 5}, platform: {name: "AlmaLinux 8 or Rocky Linux 8"}}, + (ctx) => `mongo_data_adapter/5/04_installing_the_mongo_data_adapter/${fmtArchPath(ctx)}/mongo_other_linux8_${fmtArchFilename(ctx)}.mdx`), + when({product: {name: "MongoDB Foreign Data Wrapper", version: 5}, platform: {name: "RHEL 7 or OL 7"}}, + (ctx) => `mongo_data_adapter/5/04_installing_the_mongo_data_adapter/${fmtArchPath(ctx)}/mongo_rhel7_${fmtArchFilename(ctx)}.mdx`), + when({product: {name: "MongoDB Foreign Data Wrapper", version: 5}, platform: {name: "RHEL 8 or OL 8"}}, + (ctx) => `mongo_data_adapter/5/04_installing_the_mongo_data_adapter/${fmtArchPath(ctx)}/mongo_rhel8_${fmtArchFilename(ctx)}.mdx`), + when({product: {name: "MongoDB Foreign Data Wrapper", version: 5}, platform: {name: "RHEL 8"}}, + (ctx) => `mongo_data_adapter/5/04_installing_the_mongo_data_adapter/${fmtArchPath(ctx)}/mongo_rhel8_${fmtArchFilename(ctx)}.mdx`), when({product: {name: "MySQL Foreign Data Wrapper", version: 2}, platform: {name: "SLES 12"}}, (ctx) => `mysql_data_adapter/2/04_installing_the_mysql_data_adapter/${fmtArchPath(ctx)}/mysql_sles12_${fmtArchFilename(ctx)}.mdx`), when({product: {name: "MySQL Foreign Data Wrapper", version: 2}, platform: {name: "SLES 15"}}, diff --git a/install_template/templates/products/mongodb-foreign-data-wrapper/almalinux-8-or-rocky-linux-8.njk b/install_template/templates/products/mongodb-foreign-data-wrapper/almalinux-8-or-rocky-linux-8.njk index 8bcd927e031..879f608f1ee 100644 --- a/install_template/templates/products/mongodb-foreign-data-wrapper/almalinux-8-or-rocky-linux-8.njk +++ b/install_template/templates/products/mongodb-foreign-data-wrapper/almalinux-8-or-rocky-linux-8.njk @@ -1,10 +1,2 @@ {% extends "products/mongodb-foreign-data-wrapper/base.njk" %} -{% set platformBaseTemplate = "almalinux-8-or-rocky-linux-8" %} -{% block prerequisites %} -{{ super() }} -1. Disable the built-in PostgreSQL module: - - ```sh - dnf -qy module disable postgresql - ``` -{% endblock prerequisites %} \ No newline at end of file +{% set platformBaseTemplate = "almalinux-8-or-rocky-linux-8" %} \ No newline at end of file diff --git a/install_template/templates/products/mongodb-foreign-data-wrapper/rhel-8_ppc64le.njk b/install_template/templates/products/mongodb-foreign-data-wrapper/rhel-8_ppc64le.njk new file mode 100644 index 00000000000..323b995566d --- /dev/null +++ b/install_template/templates/products/mongodb-foreign-data-wrapper/rhel-8_ppc64le.njk @@ -0,0 +1,3 @@ +{% extends "products/mongodb-foreign-data-wrapper/base.njk" %} +{% set platformBaseTemplate = "rhel-8-or-ol-8" %} +{% set includePPC = true %} diff --git a/product_docs/docs/mongo_data_adapter/5/04_installing_the_mongo_data_adapter/ibm_power_ppc64le/mongo_rhel8_ppcle.mdx b/product_docs/docs/mongo_data_adapter/5/04_installing_the_mongo_data_adapter/ibm_power_ppc64le/mongo_rhel8_ppcle.mdx index 12a1e8a3bd0..f0473a7202c 100644 --- a/product_docs/docs/mongo_data_adapter/5/04_installing_the_mongo_data_adapter/ibm_power_ppc64le/mongo_rhel8_ppcle.mdx +++ b/product_docs/docs/mongo_data_adapter/5/04_installing_the_mongo_data_adapter/ibm_power_ppc64le/mongo_rhel8_ppcle.mdx @@ -1,66 +1,44 @@ --- -title: "Installing MongoDB Foreign Data Wrapper on RHEL 8 IBM Power (ppc64le)" -navTitle: "RHEL 8" +navTitle: RHEL 8 +title: Installing MongoDB Foreign Data Wrapper on RHEL 8 ppc64le --- -There are two steps to completing an installation: - -- Setting up the repository -- Installing the package - -For each step, you must be logged in as superuser. - -To log in as a superuser: +Before you begin the installation process, log in as superuser. ```shell +# To log in as a superuser: sudo su - ``` -## Setting up the repository - -1. To register with EDB to receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request). - -1. Set up the EDB repository: - - ```shell - dnf -y install https://yum.enterprisedb.com/edbrepos/edb-repo-latest.noarch.rpm - ``` +## Set up the repository - This creates the /etc/yum.repos.d/edb.repo configuration file. +Setting up the repository is a one-time task. If you have already set up your repository, you do not need to perform this step. If you do need to set up the repository, you must register with EDB. To receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request). -1. Add your EDB credentials to the edb.repo file: - - ```shell - sed -i "s@:@USERNAME:PASSWORD@" /etc/yum.repos.d/edb.repo - ``` - - where `USERNAME:PASSWORD` is the username and password available from your - [EDB account](https://www.enterprisedb.com/user). +```shell +# Set up the EDB repository: +dnf -y install https://yum.enterprisedb.com/edbrepos/edb-repo-latest.noarch.rpm -1. Install the EPEL repository and refresh the cache: +# Replace '' and '' below with +# your username and password for the EDB repository: +sed -i "s@:@USERNAME:PASSWORD@" /etc/yum.repos.d/edb.repo - ```shell - dnf -y install https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm - dnf makecache - ``` +# Install the EPEL repository: +dnf -y install https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm -1. Enable the codeready-builder-for-rhel-8-\*-rpms repository since EPEL packages may depend on packages from it: +# Refresh the cache: +dnf makecache - ```shell - ARCH=$( /bin/arch ) - subscription-manager repos --enable "codeready-builder-for-rhel-8-${ARCH}-rpms" - ``` +# Enable additional repositories to resolve dependencies: +ARCH=$( /bin/arch ) subscription-manager repos --enable "codeready-builder-for-rhel-8-${ARCH}-rpms" -1. Disable the built-in PostgreSQL module: - ```shell - dnf -qy module disable postgresql - ``` +# Disable the built-in PostgreSQL module: +dnf -qy module disable postgresql +``` -## Installing the package +## Install the package ```shell -dnf -y install edb-as-mongo_fdw +dnf -y install edb-as14-mongo_fdw ``` -where `xx` is the server version number. - +Where `14` is the version of EDB Postgres Advanced Server. Replace `14` with the version of EDB Postgres Advanced Server you are using. diff --git a/product_docs/docs/mongo_data_adapter/5/04_installing_the_mongo_data_adapter/x86_amd64/mongo_centos7_x86.mdx b/product_docs/docs/mongo_data_adapter/5/04_installing_the_mongo_data_adapter/x86_amd64/mongo_centos7_x86.mdx index b3db364d58b..1c42e21f74e 100644 --- a/product_docs/docs/mongo_data_adapter/5/04_installing_the_mongo_data_adapter/x86_amd64/mongo_centos7_x86.mdx +++ b/product_docs/docs/mongo_data_adapter/5/04_installing_the_mongo_data_adapter/x86_amd64/mongo_centos7_x86.mdx @@ -1,31 +1,37 @@ --- -title: "Installing MongoDB Foreign Data Wrapper on CentOS 7 x86" -navTitle: "CentOS 7" +navTitle: CentOS 7 +title: Installing MongoDB Foreign Data Wrapper on CentOS 7 x86_64 --- -1. To create the repository configuration file, assume superuser privileges, and invoke the following command: +Before you begin the installation process, log in as superuser. - ```text - yum -y install https://yum.enterprisedb.com/edbrepos/edb-repo-latest.noarch.rpm - ``` +```shell +# To log in as a superuser: +sudo su - +``` -2. Replace ‘USERNAME:PASSWORD’ below with your username and password for the EDB repositories: +## Set up the repository - ```text - sed -i "s@:@USERNAME:PASSWORD@" /etc/yum.repos.d/edb.repo - ``` +Setting up the repository is a one-time task. If you have already set up your repository, you do not need to perform this step. If you do need to set up the repository, you must register with EDB. To receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request). -3. Install the EPEL repository: +```shell +# Set up the EDB repository: +yum -y install https://yum.enterprisedb.com/edbrepos/edb-repo-latest.noarch.rpm - ```text - yum -y install https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm - ``` - -5. Install the selected package: +# Replace '' and '' below with +# your username and password for the EDB repository: +sed -i "s@:@USERNAME:PASSWORD@" /etc/yum.repos.d/edb.repo - ```text - dnf install edb-as-mongo_fdw - ``` +# Install the EPEL repository: +yum -y install https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm - where `xx` is the server version number. +``` + +## Install the package + +```shell +yum -y install edb-as14-mongo_fdw +``` + +Where `14` is the version of EDB Postgres Advanced Server. Replace `14` with the version of EDB Postgres Advanced Server you are using. diff --git a/product_docs/docs/mongo_data_adapter/5/04_installing_the_mongo_data_adapter/x86_amd64/mongo_other_linux8_x86.mdx b/product_docs/docs/mongo_data_adapter/5/04_installing_the_mongo_data_adapter/x86_amd64/mongo_other_linux8_x86.mdx index ebc9671a4f1..7f976b231da 100644 --- a/product_docs/docs/mongo_data_adapter/5/04_installing_the_mongo_data_adapter/x86_amd64/mongo_other_linux8_x86.mdx +++ b/product_docs/docs/mongo_data_adapter/5/04_installing_the_mongo_data_adapter/x86_amd64/mongo_other_linux8_x86.mdx @@ -1,42 +1,41 @@ --- -title: "Installing MongoDB Foreign Data Wrapper on Rocky Linux 8/AlmaLinux 8 x86" -navTitle: "Rocky Linux 8/AlmaLinux 8" +navTitle: AlmaLinux 8 or Rocky Linux 8 +title: Installing MongoDB Foreign Data Wrapper on AlmaLinux 8 or Rocky Linux 8 x86_64 --- -1. To create the repository configuration file, assume superuser privileges, and invoke the following command: - - ```text - dnf -y install https://yum.enterprisedb.com/edbrepos/edb-repo-latest.noarch.rpm - ``` +Before you begin the installation process, log in as superuser. -2. Replace ‘USERNAME:PASSWORD’ below with your username and password for the EDB repositories: +```shell +# To log in as a superuser: +sudo su - +``` - ```text - sed -i "s@:@USERNAME:PASSWORD@" /etc/yum.repos.d/edb.repo - ``` +## Set up the repository -3. Install the EPEL repository: +Setting up the repository is a one-time task. If you have already set up your repository, you do not need to perform this step. If you do need to set up the repository, you must register with EDB. To receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request). - ```text - dnf -y install epel-release - ``` +```shell +# Set up the EDB repository: +dnf -y install https://yum.enterprisedb.com/edbrepos/edb-repo-latest.noarch.rpm -4. Enable additional repositories to resolve dependencies: +# Replace '' and '' below with +# your username and password for the EDB repository: +sed -i "s@:@USERNAME:PASSWORD@" /etc/yum.repos.d/edb.repo - ```text - dnf config-manager --set-enabled PowerTools - ``` +# Install the EPEL repository: +dnf -y install epel-release -5. Disable the built-in PostgreSQL module: +# Enable additional repositories to resolve dependencies: +dnf config-manager --set-enabled PowerTools - ```text - dnf -qy module disable postgresql - ``` +# Disable the built-in PostgreSQL module: +dnf -qy module disable postgresql +``` -6. Install the selected package: - - ```text - dnf install edb-as-mongo_fdw - ``` +## Install the package - where `xx` is the server version number. \ No newline at end of file +```shell +dnf -y install edb-as14-mongo_fdw +``` + +Where `14` is the version of EDB Postgres Advanced Server. Replace `14` with the version of EDB Postgres Advanced Server you are using. diff --git a/product_docs/docs/mongo_data_adapter/5/04_installing_the_mongo_data_adapter/x86_amd64/mongo_rhel7_x86.mdx b/product_docs/docs/mongo_data_adapter/5/04_installing_the_mongo_data_adapter/x86_amd64/mongo_rhel7_x86.mdx index e6b783ca1d7..2994671ceb8 100644 --- a/product_docs/docs/mongo_data_adapter/5/04_installing_the_mongo_data_adapter/x86_amd64/mongo_rhel7_x86.mdx +++ b/product_docs/docs/mongo_data_adapter/5/04_installing_the_mongo_data_adapter/x86_amd64/mongo_rhel7_x86.mdx @@ -1,37 +1,38 @@ --- -title: "Installing MongoDB Foreign Data Wrapper on RHEL 7/OL 7 x86" -navTitle: "RHEL 7/OL 7 " +navTitle: RHEL 7 or OL 7 +title: Installing MongoDB Foreign Data Wrapper on RHEL 7 or OL 7 x86_64 --- -1. To create the repository configuration file, assume superuser privileges, and invoke the following command: +Before you begin the installation process, log in as superuser. - ```text - yum -y install https://yum.enterprisedb.com/edbrepos/edb-repo-latest.noarch.rpm - ``` +```shell +# To log in as a superuser: +sudo su - +``` -2. Replace ‘USERNAME:PASSWORD’ below with your username and password for the EDB repositories: +## Set up the repository - ```text - sed -i "s@:@USERNAME:PASSWORD@" /etc/yum.repos.d/edb.repo - ``` +Setting up the repository is a one-time task. If you have already set up your repository, you do not need to perform this step. If you do need to set up the repository, you must register with EDB. To receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request). -3. Install the EPEL repository: +```shell +# Set up the EDB repository: +yum -y install https://yum.enterprisedb.com/edbrepos/edb-repo-latest.noarch.rpm - ```text - yum -y install https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm - ``` +# Replace '' and '' below with +# your username and password for the EDB repository: +sed -i "s@:@USERNAME:PASSWORD@" /etc/yum.repos.d/edb.repo -4. Enable additional repositories to resolve dependencies: +# Install the EPEL repository: +yum -y install https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm - ```text - subscription-manager repos --enable "rhel-*-optional-rpms" --enable "rhel-*-extras-rpms" --enable "rhel-ha-for-rhel-*-server-rpms" - ``` +# Enable additional repositories to resolve dependencies: +subscription-manager repos --enable "rhel-*-optional-rpms" --enable "rhel-*-extras-rpms" --enable "rhel-ha-for-rhel-*-server-rpms" +``` -5. Install the selected package: +## Install the package - ```text - dnf install edb-as-mongo_fdw - ``` - - where `xx` is the server version number. +```shell +yum -y install edb-as14-mongo_fdw +``` +Where `14` is the version of EDB Postgres Advanced Server. Replace `14` with the version of EDB Postgres Advanced Server you are using. diff --git a/product_docs/docs/mongo_data_adapter/5/04_installing_the_mongo_data_adapter/x86_amd64/mongo_rhel8_x86.mdx b/product_docs/docs/mongo_data_adapter/5/04_installing_the_mongo_data_adapter/x86_amd64/mongo_rhel8_x86.mdx index 9cf49d211fa..a214b6985a2 100644 --- a/product_docs/docs/mongo_data_adapter/5/04_installing_the_mongo_data_adapter/x86_amd64/mongo_rhel8_x86.mdx +++ b/product_docs/docs/mongo_data_adapter/5/04_installing_the_mongo_data_adapter/x86_amd64/mongo_rhel8_x86.mdx @@ -1,41 +1,41 @@ --- -title: "Installing MongoDB Foreign Data Wrapper on RHEL 8/OL 8 x86" -navTitle: "RHEL 8/OL 8" +navTitle: RHEL 8 or OL 8 +title: Installing MongoDB Foreign Data Wrapper on RHEL 8 or OL 8 x86_64 --- -1. To create the repository configuration file, assume superuser privileges, and invoke the following command: - - ```text - dnf -y install https://yum.enterprisedb.com/edbrepos/edb-repo-latest.noarch.rpm - ``` +Before you begin the installation process, log in as superuser. -2. Replace ‘USERNAME:PASSWORD’ below with your username and password for the EDB repositories: +```shell +# To log in as a superuser: +sudo su - +``` - ```text - sed -i "s@:@USERNAME:PASSWORD@" /etc/yum.repos.d/edb.repo - ``` +## Set up the repository -3. Install the EPEL repository: +Setting up the repository is a one-time task. If you have already set up your repository, you do not need to perform this step. If you do need to set up the repository, you must register with EDB. To receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request). - ```text - dnf -y install https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm - ``` +```shell +# Set up the EDB repository: +dnf -y install https://yum.enterprisedb.com/edbrepos/edb-repo-latest.noarch.rpm -4. Enable additional repositories to resolve dependencies: +# Replace '' and '' below with +# your username and password for the EDB repository: +sed -i "s@:@USERNAME:PASSWORD@" /etc/yum.repos.d/edb.repo - ```text - ARCH=$( /bin/arch ) subscription-manager repos --enable "codeready-builder-for-rhel-8-${ARCH}-rpms" - ``` +# Install the EPEL repository: +dnf -y install https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm -5. Disable the built-in PostgreSQL module: +# Enable additional repositories to resolve dependencies: +ARCH=$( /bin/arch ) subscription-manager repos --enable "codeready-builder-for-rhel-8-${ARCH}-rpms" - ```text - dnf -qy module disable postgresql - ``` -6. Install the selected package: - - ```text - dnf install edb-as-mongo_fdw - ``` +# Disable the built-in PostgreSQL module: +dnf -qy module disable postgresql +``` - where `xx` is the server version number. \ No newline at end of file +## Install the package + +```shell +dnf -y install edb-as14-mongo_fdw +``` + +Where `14` is the version of EDB Postgres Advanced Server. Replace `14` with the version of EDB Postgres Advanced Server you are using. From af96ca621e33b7bbda9d2b3163940ec4db637381 Mon Sep 17 00:00:00 2001 From: David Wicinas <93669463+dwicinas@users.noreply.github.com> Date: Thu, 4 Aug 2022 12:56:32 -0400 Subject: [PATCH 04/16] Changes to template files and generated files for MySQL --- install_template/config.yaml | 8 +- install_template/deploy.mjs | 24 ++++- .../almalinux-8-or-rocky-linux-8.njk | 25 ++++-- .../mysql-foreign-data-wrapper/centos-7.njk | 17 +++- .../rhel-7-or-ol-7.njk | 17 +++- .../rhel-8-or-ol-8.njk | 4 +- .../rhel-8_ppc64le.njk | 3 + .../ibm_power_ppc64le/mysql_rhel8_ppcle.mdx | 72 +++++---------- .../x86_amd64/mysql_centos7_x86.mdx | 80 ++++++----------- .../x86_amd64/mysql_other_linux8_x86.mdx | 69 +++++---------- .../x86_amd64/mysql_rhel7_x86.mdx | 87 +++++++------------ .../x86_amd64/mysql_rhel8_x86.mdx | 70 +++++---------- 12 files changed, 208 insertions(+), 268 deletions(-) create mode 100644 install_template/templates/products/mysql-foreign-data-wrapper/rhel-8_ppc64le.njk diff --git a/install_template/config.yaml b/install_template/config.yaml index 2a0c4b038cf..2e90bdd4aef 100644 --- a/install_template/config.yaml +++ b/install_template/config.yaml @@ -487,9 +487,6 @@ products: - name: CentOS 7 arch: x86_64 supported versions: [2] - - name: CentOS 7 - arch: ppc64le - supported versions: [2] - name: AlmaLinux 8 or Rocky Linux 8 arch: x86_64 supported versions: [2] @@ -498,7 +495,10 @@ products: supported versions: [2] - name: RHEL 8 or OL 8 arch: x86_64 - supported versions: [11, 12, 13, 14] + supported versions: [2] + - name: RHEL 8 + arch: ppc64le + supported versions: [2] - name: Ubuntu 18.04 arch: x86_64 supported versions: [2] diff --git a/install_template/deploy.mjs b/install_template/deploy.mjs index 1f7b31a3c1e..4f5be102f4c 100644 --- a/install_template/deploy.mjs +++ b/install_template/deploy.mjs @@ -262,7 +262,29 @@ const moveDoc = async (product, platform, version) => { (ctx) => `mysql_data_adapter/2/04_installing_the_mysql_data_adapter/${fmtArchPath(ctx)}/mysql_ubuntu18_${fmtArchFilename(ctx)}.mdx`), when({product: {name: "MySQL Foreign Data Wrapper", version: 2}, platform: {name: "Ubuntu 20.04"}}, (ctx) => `mysql_data_adapter/2/04_installing_the_mysql_data_adapter/${fmtArchPath(ctx)}/mysql_ubuntu20_${fmtArchFilename(ctx)}.mdx`), - when({product: {name: "EDB OCL Connector"}, platform: {name: "SLES 12"}}, + when({product: {name: "MySQL Foreign Data Wrapper", version: 2}, platform: {name: "CentOS 7"}}, + (ctx) => `mysql_data_adapter/2/04_installing_the_mysql_data_adapter/${fmtArchPath(ctx)}/mysql_centos7_${fmtArchFilename(ctx)}.mdx`), + when({product: {name: "MySQL Foreign Data Wrapper", version: 2}, platform: {name: "AlmaLinux 8 or Rocky Linux 8"}}, + (ctx) => `mysql_data_adapter/2/04_installing_the_mysql_data_adapter/${fmtArchPath(ctx)}/mysql_other_linux8_${fmtArchFilename(ctx)}.mdx`), + when({product: {name: "MySQL Foreign Data Wrapper", version: 2}, platform: {name: "RHEL 7 or OL 7"}}, + (ctx) => `mysql_data_adapter/2/04_installing_the_mysql_data_adapter/${fmtArchPath(ctx)}/mysql_rhel7_${fmtArchFilename(ctx)}.mdx`), + when({product: {name: "MySQL Foreign Data Wrapper", version: 2}, platform: {name: "RHEL 8 or OL 8"}}, + (ctx) => `mysql_data_adapter/2/04_installing_the_mysql_data_adapter/${fmtArchPath(ctx)}/mysql_rhel8_${fmtArchFilename(ctx)}.mdx`), + when({product: {name: "MySQL Foreign Data Wrapper", version: 2}, platform: {name: "RHEL 8"}}, + (ctx) => `mysql_data_adapter/2/04_installing_the_mysql_data_adapter/${fmtArchPath(ctx)}/mysql_rhel8_${fmtArchFilename(ctx)}.mdx`), + + + + + + + + + + + + + when({product: {name: "EDB OCL Connector"}, platform: {name: "SLES 12"}}, (ctx) => `ocl_connector/${ctx.product.version}/04_open_client_library/01_installing_and_configuring_the_ocl_connector/install_on_linux_using_edb_repo/${fmtArchPath(ctx)}/ocl_connector14_sles12_${fmtArchFilename(ctx)}.mdx`), when({product: {name: "EDB OCL Connector"}, platform: {name: "SLES 15"}}, (ctx) => `ocl_connector/${ctx.product.version}/04_open_client_library/01_installing_and_configuring_the_ocl_connector/install_on_linux_using_edb_repo/${fmtArchPath(ctx)}/ocl_connector14_sles15_${fmtArchFilename(ctx)}.mdx`), diff --git a/install_template/templates/products/mysql-foreign-data-wrapper/almalinux-8-or-rocky-linux-8.njk b/install_template/templates/products/mysql-foreign-data-wrapper/almalinux-8-or-rocky-linux-8.njk index 6a52895a4e5..152d0a5b05a 100644 --- a/install_template/templates/products/mysql-foreign-data-wrapper/almalinux-8-or-rocky-linux-8.njk +++ b/install_template/templates/products/mysql-foreign-data-wrapper/almalinux-8-or-rocky-linux-8.njk @@ -1,10 +1,23 @@ {% extends "products/mysql-foreign-data-wrapper/base.njk" %} {% set platformBaseTemplate = "almalinux-8-or-rocky-linux-8" %} +{% set packageManager = "dnf" %} {% block prerequisites %} -{{ super() }} -1. Disable the built-in PostgreSQL module: +```shell +# Set up the EDB repository: +{{ packageManager }} -y install https://yum.enterprisedb.com/edbrepos/edb-repo-latest.noarch.rpm + +# Replace '' and '' below with +# your username and password for the EDB repository: +sed -i "s@:@USERNAME:PASSWORD@" /etc/yum.repos.d/edb.repo + +# Install the EPEL repository: +{{ packageManager }} -y install "https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm" + +{% block redhatConfig %}# Enable additional repositories to resolve dependencies: +dnf config-manager --set-enabled PowerTools{% endblock redhatConfig %} +``` +{% endblock prerequisites %} + + + - ```sh - dnf -qy module disable postgresql - ``` -{% endblock prerequisites %} \ No newline at end of file diff --git a/install_template/templates/products/mysql-foreign-data-wrapper/centos-7.njk b/install_template/templates/products/mysql-foreign-data-wrapper/centos-7.njk index 3b83c16d289..8d3a1573e62 100644 --- a/install_template/templates/products/mysql-foreign-data-wrapper/centos-7.njk +++ b/install_template/templates/products/mysql-foreign-data-wrapper/centos-7.njk @@ -1,2 +1,17 @@ {% extends "products/mysql-foreign-data-wrapper/base.njk" %} -{% set platformBaseTemplate = "centos-7" %} \ No newline at end of file +{% set platformBaseTemplate = "centos-7" %} +{% block installCommand %} +```shell +# Download and install the MySQL repo: +{{packageManager}} -y install https://dev.mysql.com/get/mysql80-community-release-el7-3.noarch.rpm + +# For MySQL 8, enable the appropriate subrepository and install +# the MySQL Foreign data Wrapper: +yum -y install --enablerepo=mysql80-community --disablerepo=mysql57-community edb-as-mysql_fdw + +# For MySQL 5, enable the appropriate subrepository and install +# the MySQL Foreign data Wrapper: +{{packageManager}} -y install --enablerepo=mysql57-community --disablerepo=mysql80-community edb-as-mysql_fdw +``` +Where `` is the version of EDB Postgres Advanced server and `` is the version of MySQL to be installed. For example if EDB Postgres Version is 13 and MySQL version is 8 then the package name is `edb-as13-mysql8-fdw`. +{% endblock installCommand %} \ No newline at end of file diff --git a/install_template/templates/products/mysql-foreign-data-wrapper/rhel-7-or-ol-7.njk b/install_template/templates/products/mysql-foreign-data-wrapper/rhel-7-or-ol-7.njk index 3e29f41d483..9f1d4b4a07d 100644 --- a/install_template/templates/products/mysql-foreign-data-wrapper/rhel-7-or-ol-7.njk +++ b/install_template/templates/products/mysql-foreign-data-wrapper/rhel-7-or-ol-7.njk @@ -1,2 +1,17 @@ {% extends "products/mysql-foreign-data-wrapper/base.njk" %} -{% set platformBaseTemplate = "rhel-7-or-ol-7" %} \ No newline at end of file +{% set platformBaseTemplate = "rhel-7-or-ol-7" %} +{% block installCommand %} +```shell +# Download and install the MySQL repo: +{{packageManager}} -y install https://dev.mysql.com/get/mysql80-community-release-el7-3.noarch.rpm + +# For MySQL 8, enable the appropriate subrepository and install +# the MySQL Foreign data Wrapper: +yum -y install --enablerepo=mysql80-community --disablerepo=mysql57-community edb-as-mysql_fdw + +# For MySQL 5, enable the appropriate subrepository and install +# the MySQL Foreign data Wrapper: +{{packageManager}} -y install --enablerepo=mysql57-community --disablerepo=mysql80-community edb-as-mysql_fdw +``` +Where `` is the version of EDB Postgres Advanced server and `` is the version of MySQL to be installed. For example if EDB Postgres Version is 13 and MySQL version is 8 then the package name is `edb-as13-mysql8-fdw`. +{% endblock installCommand %} \ No newline at end of file diff --git a/install_template/templates/products/mysql-foreign-data-wrapper/rhel-8-or-ol-8.njk b/install_template/templates/products/mysql-foreign-data-wrapper/rhel-8-or-ol-8.njk index cd91fd8d8d3..e0796563739 100644 --- a/install_template/templates/products/mysql-foreign-data-wrapper/rhel-8-or-ol-8.njk +++ b/install_template/templates/products/mysql-foreign-data-wrapper/rhel-8-or-ol-8.njk @@ -1,2 +1,4 @@ {% extends "products/mysql-foreign-data-wrapper/base.njk" %} -{% set platformBaseTemplate = "rhel-8-or-ol-8" %} \ No newline at end of file +{% set platformBaseTemplate = "rhel-8-or-ol-8" %} +{% block redhatConfig %}# Enable additional repositories to resolve dependencies: +ARCH=$( /bin/arch ) subscription-manager repos --enable "codeready-builder-for-rhel-8-${ARCH}-rpms"{% endblock redhatConfig %} \ No newline at end of file diff --git a/install_template/templates/products/mysql-foreign-data-wrapper/rhel-8_ppc64le.njk b/install_template/templates/products/mysql-foreign-data-wrapper/rhel-8_ppc64le.njk new file mode 100644 index 00000000000..b8c72f9d057 --- /dev/null +++ b/install_template/templates/products/mysql-foreign-data-wrapper/rhel-8_ppc64le.njk @@ -0,0 +1,3 @@ +{% extends "products/mysql-foreign-data-wrapper/base.njk" %} +{% set platformBaseTemplate = "rhel-8-or-ol-8" %} +{% set includePPC = true %} diff --git a/product_docs/docs/mysql_data_adapter/2/04_installing_the_mysql_data_adapter/ibm_power_ppc64le/mysql_rhel8_ppcle.mdx b/product_docs/docs/mysql_data_adapter/2/04_installing_the_mysql_data_adapter/ibm_power_ppc64le/mysql_rhel8_ppcle.mdx index 1e737a1ce8f..5ef3b7e9732 100644 --- a/product_docs/docs/mysql_data_adapter/2/04_installing_the_mysql_data_adapter/ibm_power_ppc64le/mysql_rhel8_ppcle.mdx +++ b/product_docs/docs/mysql_data_adapter/2/04_installing_the_mysql_data_adapter/ibm_power_ppc64le/mysql_rhel8_ppcle.mdx @@ -1,68 +1,44 @@ --- -title: "Installing MySQL Foreign Data Wrapper on RHEL 8 IBM Power (ppc64le)" -navTitle: "RHEL 8" +navTitle: RHEL 8 +title: Installing MySQL Foreign Data Wrapper on RHEL 8 ppc64le --- -There are two steps to completing an installation: - -- Setting up the repository -- Installing the package - -For each step, you must be logged in as superuser. - -To log in as a superuser: +Before you begin the installation process, log in as superuser. ```shell +# To log in as a superuser: sudo su - ``` -## Setting up the repository - -1. To register with EDB to receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request). - -1. Set up the EDB repository: - - ```shell - dnf -y install https://yum.enterprisedb.com/edbrepos/edb-repo-latest.noarch.rpm - ``` - - This creates the /etc/yum.repos.d/edb.repo configuration file. +## Set up the repository -1. Add your EDB credentials to the edb.repo file: +Setting up the repository is a one-time task. If you have already set up your repository, you do not need to perform this step. If you do need to set up the repository, you must register with EDB. To receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request). - ```shell - sed -i "s@:@USERNAME:PASSWORD@" /etc/yum.repos.d/edb.repo - ``` - - Where `USERNAME:PASSWORD` is the username and password available from your - [EDB account](https://www.enterprisedb.com/user). +```shell +# Set up the EDB repository: +dnf -y install https://yum.enterprisedb.com/edbrepos/edb-repo-latest.noarch.rpm -1. Install the EPEL repository and refresh the cache: +# Replace '' and '' below with +# your username and password for the EDB repository: +sed -i "s@:@USERNAME:PASSWORD@" /etc/yum.repos.d/edb.repo - ```shell - dnf -y install https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm - dnf makecache - ``` +# Install the EPEL repository: +dnf -y install https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm -1. Enable the codeready-builder-for-rhel-8-\*-rpms repository since EPEL packages may depend on packages from it: +# Refresh the cache: +dnf makecache - ```shell - ARCH=$( /bin/arch ) - subscription-manager repos --enable "codeready-builder-for-rhel-8-${ARCH}-rpms" - ``` +# Enable additional repositories to resolve dependencies: +ARCH=$( /bin/arch ) subscription-manager repos --enable "codeready-builder-for-rhel-8-${ARCH}-rpms" -1. Disable the built-in PostgreSQL module: - ```shell - dnf -qy module disable postgresql - ``` +# Disable the built-in PostgreSQL module: +dnf -qy module disable postgresql +``` -## Installing the package +## Install the package ```shell -dnf -y install edb-as-mysql8_fdw +dnf -y install edb-as-mysql-fdw ``` -where `xx` is the server version number. - - - +Where `` is the version of EDB Postgres Advanced server and `` is the version of MySQL to be installed. For example if EDB Postgres Version is 13 and MySQL version is 8 then the package name is `edb-as13-mysql8-fdw`. diff --git a/product_docs/docs/mysql_data_adapter/2/04_installing_the_mysql_data_adapter/x86_amd64/mysql_centos7_x86.mdx b/product_docs/docs/mysql_data_adapter/2/04_installing_the_mysql_data_adapter/x86_amd64/mysql_centos7_x86.mdx index 4c85d3b47dc..fcd01cbb19d 100644 --- a/product_docs/docs/mysql_data_adapter/2/04_installing_the_mysql_data_adapter/x86_amd64/mysql_centos7_x86.mdx +++ b/product_docs/docs/mysql_data_adapter/2/04_installing_the_mysql_data_adapter/x86_amd64/mysql_centos7_x86.mdx @@ -1,72 +1,46 @@ --- -title: "Installing MySQL Foreign Data Wrapper on CentOS 7 x86" -navTitle: "CentOS 7" +navTitle: CentOS 7 +title: Installing MySQL Foreign Data Wrapper on CentOS 7 x86_64 --- -Before installing the MySQL Foreign Data Wrapper, you must install the following prerequisite packages, and request credentials from EDB: +Before you begin the installation process, log in as superuser. -Install the `epel-release` package: - -```text -yum -y install https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm +```shell +# To log in as a superuser: +sudo su - ``` -You may need to enable the `[extras]` repository definition in the `CentOS-Base.repo` file (located in `/etc/yum.repos.d`). - -You must also have credentials that allow access to the EDB repository. For information about requesting credentials, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request). - -After receiving your repository credentials you can: - -1. Create the repository configuration file. -2. Modify the file, providing your user name and password. -3. Install the MySQL Foreign Data Wrapper. - -## Creating a repository configuration file +## Set up the repository -To create the repository configuration file, assume superuser privileges, and invoke the following command: +Setting up the repository is a one-time task. If you have already set up your repository, you do not need to perform this step. If you do need to set up the repository, you must register with EDB. To receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request). -```text +```shell +# Set up the EDB repository: yum -y install https://yum.enterprisedb.com/edbrepos/edb-repo-latest.noarch.rpm -``` -The repository configuration file is named `edb.repo`. The file resides in `/etc/yum.repos.d`. +# Replace '' and '' below with +# your username and password for the EDB repository: +sed -i "s@:@USERNAME:PASSWORD@" /etc/yum.repos.d/edb.repo -## Modifying the file, providing your user name and password +# Install the EPEL repository: +yum -y install https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm -After creating the `edb.repo` file, use your choice of editor to ensure that the value of the `enabled` parameter is `1`, and replace the `username` and `password` placeholders in the `baseurl` specification with the name and password of a registered EDB user. -```text -[edb] -name=EnterpriseDB RPMs $releasever - $basearch -baseurl=https://:@yum.enterprisedb.com/edb/redhat/rhel-$releasever-$basearch -enabled=1 -gpgcheck=1 -repo_gpgcheck=1 -gpgkey=file:///etc/pki/rpm-gpg/ENTERPRISEDB-GPG-KEY ``` -## Installing MySQL Foreign Data Wrapper - -1. Before installing MySQL FDW, download and install the MySQL repo using the following commands: - - ```text - yum -y install https://dev.mysql.com/get/mysql80-community-release-el7-3.noarch.rpm - ``` +## Install the package -2. Use the following command to enable the appropriate subrepository and install the MySQL Foreign data Wrapper: - - For MySQL 8: - ```text - yum -y install --enablerepo=mysql80-community --disablerepo=mysql57-community edb-as-mysql8_fdw - ``` - - For MySQL 5: - ```text - yum -y install --enablerepo=mysql57-community --disablerepo=mysql80-community edb-as-mysql5_fdw - ``` -Where `xx` is the server version number i.e. 13. - -When you install an RPM package that is signed by a source that is not recognized by your system, yum may ask for your permission to import the key to your local server. If prompted, and you are satisfied that the packages come from a trustworthy source, enter `y`, and press `Return` to continue. - -During the installation, yum may encounter a dependency that it cannot resolve. If it does, it will provide a list of the required dependencies that you must manually resolve. +```shell +# Download and install the MySQL repo: +yum -y install https://dev.mysql.com/get/mysql80-community-release-el7-3.noarch.rpm +# For MySQL 8, enable the appropriate subrepository and install +# the MySQL Foreign data Wrapper: +yum -y install --enablerepo=mysql80-community --disablerepo=mysql57-community edb-as-mysql_fdw +# For MySQL 5, enable the appropriate subrepository and install +# the MySQL Foreign data Wrapper: +yum -y install --enablerepo=mysql57-community --disablerepo=mysql80-community edb-as-mysql_fdw +``` +Where `` is the version of EDB Postgres Advanced server and `` is the version of MySQL to be installed. For example if EDB Postgres Version is 13 and MySQL version is 8 then the package name is `edb-as13-mysql8-fdw`. diff --git a/product_docs/docs/mysql_data_adapter/2/04_installing_the_mysql_data_adapter/x86_amd64/mysql_other_linux8_x86.mdx b/product_docs/docs/mysql_data_adapter/2/04_installing_the_mysql_data_adapter/x86_amd64/mysql_other_linux8_x86.mdx index 86d4ab1ae42..7143a894acb 100644 --- a/product_docs/docs/mysql_data_adapter/2/04_installing_the_mysql_data_adapter/x86_amd64/mysql_other_linux8_x86.mdx +++ b/product_docs/docs/mysql_data_adapter/2/04_installing_the_mysql_data_adapter/x86_amd64/mysql_other_linux8_x86.mdx @@ -1,63 +1,38 @@ --- -title: "Installing MySQL Foreign Data Wrapper on Rocky Linux 8/AlmaLinux 8 x86" -navTitle: "Rocky Linux 8/AlmaLinux 8" +navTitle: AlmaLinux 8 or Rocky Linux 8 +title: Installing MySQL Foreign Data Wrapper on AlmaLinux 8 or Rocky Linux 8 x86_64 --- -Before installing the MySQL Foreign Data Wrapper, you must install the following prerequisite packages, and request credentials from EDB: +Before you begin the installation process, log in as superuser. -Install the `epel-release` package: - -```text -dnf -y install https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm +```shell +# To log in as a superuser: +sudo su - ``` -Enable the `PowerTools` repository: - -```text -dnf config-manager --set-enabled PowerTools -``` +## Set up the repository -You must also have credentials that allow access to the EDB repository. For information about requesting credentials, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request). +Setting up the repository is a one-time task. If you have already set up your repository, you do not need to perform this step. If you do need to set up the repository, you must register with EDB. To receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request). -After receiving your repository credentials you can: +```shell +# Set up the EDB repository: +dnf -y install https://yum.enterprisedb.com/edbrepos/edb-repo-latest.noarch.rpm -1. Create the repository configuration file. -2. Modify the file, providing your user name and password. -3. Install the MySQL Foreign Data Wrapper. +# Replace '' and '' below with +# your username and password for the EDB repository: +sed -i "s@:@USERNAME:PASSWORD@" /etc/yum.repos.d/edb.repo -## Creating a repository configuration file - -To create the repository configuration file, assume superuser privileges, and invoke the following command: - -```text -dnf -y https://yum.enterprisedb.com/edbrepos/edb-repo-latest.noarch.rpm -``` +# Install the EPEL repository: +dnf -y install "https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm" -The repository configuration file is named `edb.repo`. The file resides in `/etc/yum.repos.d`. - -## Modifying the file, providing your user name and password - -After creating the `edb.repo` file, use your choice of editor to ensure that the value of the `enabled` parameter is `1`, and replace the `username` and `password` placeholders in the `baseurl` specification with the name and password of a registered EDB user. - -```text -[edb] -name=EnterpriseDB RPMs $releasever - $basearch -baseurl=https://:@yum.enterprisedb.com/edb/redhat/rhel-$releasever-$basearch -enabled=1 -gpgcheck=1 -repo_gpgcheck=1 -gpgkey=file:///etc/pki/rpm-gpg/ENTERPRISEDB-GPG-KEY +# Enable additional repositories to resolve dependencies: +dnf config-manager --set-enabled PowerTools ``` -## Installing MySQL Foreign Data Wrapper -After saving your changes to the configuration file, use the below command to install the MySQL Foreign Data Wrapper: +## Install the package -```text -dnf install edb-as-mysql8_fdw +```shell +dnf -y install edb-as-mysql-fdw ``` -Where `xx` is the server version number i.e. 13. - -When you install an RPM package that is signed by a source that is not recognized by your system, yum may ask for your permission to import the key to your local server. If prompted, and you are satisfied that the packages come from a trustworthy source, enter `y`, and press `Return` to continue. - -During the installation, yum may encounter a dependency that it cannot resolve. If it does, it will provide a list of the required dependencies that you must manually resolve. +Where `` is the version of EDB Postgres Advanced server and `` is the version of MySQL to be installed. For example if EDB Postgres Version is 13 and MySQL version is 8 then the package name is `edb-as13-mysql8-fdw`. diff --git a/product_docs/docs/mysql_data_adapter/2/04_installing_the_mysql_data_adapter/x86_amd64/mysql_rhel7_x86.mdx b/product_docs/docs/mysql_data_adapter/2/04_installing_the_mysql_data_adapter/x86_amd64/mysql_rhel7_x86.mdx index 13a5698c7cf..b42a41d441e 100644 --- a/product_docs/docs/mysql_data_adapter/2/04_installing_the_mysql_data_adapter/x86_amd64/mysql_rhel7_x86.mdx +++ b/product_docs/docs/mysql_data_adapter/2/04_installing_the_mysql_data_adapter/x86_amd64/mysql_rhel7_x86.mdx @@ -1,76 +1,47 @@ --- -title: "Installing MySQL Foreign Data Wrapper on RHEL 7/OL 7 x86" -navTitle: "RHEL 7/OL 7" +navTitle: RHEL 7 or OL 7 +title: Installing MySQL Foreign Data Wrapper on RHEL 7 or OL 7 x86_64 --- -Before installing the MySQL Foreign Data Wrapper, you must install the following prerequisite packages, and request credentials from EDB: +Before you begin the installation process, log in as superuser. -Install the `epel-release` package: - -```text -yum -y install https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm +```shell +# To log in as a superuser: +sudo su - ``` -Enable the optional, extras, and HA repositories: - -```text -subscription-manager repos --enable "rhel-*-optional-rpms" --enable "rhel-*-extras-rpms" --enable "rhel-ha-for-rhel-*-server-rpms" -``` - -You must also have credentials that allow access to the EDB repository. For information about requesting credentials, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request). - -After receiving your repository credentials you can: - -1. Create the repository configuration file. -2. Modify the file, providing your user name and password. -3. Install the MySQL Foreign Data Wrapper. - -## Creating a repository configuration file +## Set up the repository -To create the repository configuration file, assume superuser privileges, and invoke the following command: +Setting up the repository is a one-time task. If you have already set up your repository, you do not need to perform this step. If you do need to set up the repository, you must register with EDB. To receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request). -```text +```shell +# Set up the EDB repository: yum -y install https://yum.enterprisedb.com/edbrepos/edb-repo-latest.noarch.rpm -``` - -The repository configuration file is named `edb.repo`. The file resides in `/etc/yum.repos.d`. -## Modifying the file, providing your user name and password +# Replace '' and '' below with +# your username and password for the EDB repository: +sed -i "s@:@USERNAME:PASSWORD@" /etc/yum.repos.d/edb.repo -After creating the `edb.repo` file, use your choice of editor to ensure that the value of the `enabled` parameter is `1`, and replace the `username` and `password` placeholders in the `baseurl` specification with the name and password of a registered EDB user. +# Install the EPEL repository: +yum -y install https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm -```text -[edb] -name=EnterpriseDB RPMs $releasever - $basearch -baseurl=https://:@yum.enterprisedb.com/edb/redhat/rhel-$releasever-$basearch -enabled=1 -gpgcheck=1 -repo_gpgcheck=1 -gpgkey=file:///etc/pki/rpm-gpg/ENTERPRISEDB-GPG-KEY +# Enable additional repositories to resolve dependencies: +subscription-manager repos --enable "rhel-*-optional-rpms" --enable "rhel-*-extras-rpms" --enable "rhel-ha-for-rhel-*-server-rpms" ``` -## Installing MySQL Foreign Data Wrapper +## Install the package -1. Before installing MySQL FDW, download and install the MySQL repo using the following commands: - - ```text - yum -y install https://dev.mysql.com/get/mysql80-community-release-el7-3.noarch.rpm - ``` - -2. Use the following command to enable the appropriate subrepository and install the MySQL Foreign data Wrapper: - - For MySQL 8: - ```text - yum -y install --enablerepo=mysql80-community --disablerepo=mysql57-community edb-as-mysql8_fdw - ``` - - For MySQL 5: - ```text - yum -y install --enablerepo=mysql57-community --disablerepo=mysql80-community edb-as-mysql5_fdw - ``` -Where `xx` is the server version number i.e. 13. - -When you install an RPM package that is signed by a source that is not recognized by your system, yum may ask for your permission to import the key to your local server. If prompted, and you are satisfied that the packages come from a trustworthy source, enter `y`, and press `Return` to continue. - -During the installation, yum may encounter a dependency that it cannot resolve. If it does, it will provide a list of the required dependencies that you must manually resolve. +```shell +# Download and install the MySQL repo: +yum -y install https://dev.mysql.com/get/mysql80-community-release-el7-3.noarch.rpm +# For MySQL 8, enable the appropriate subrepository and install +# the MySQL Foreign data Wrapper: +yum -y install --enablerepo=mysql80-community --disablerepo=mysql57-community edb-as-mysql_fdw +# For MySQL 5, enable the appropriate subrepository and install +# the MySQL Foreign data Wrapper: +yum -y install --enablerepo=mysql57-community --disablerepo=mysql80-community edb-as-mysql_fdw +``` +Where `` is the version of EDB Postgres Advanced server and `` is the version of MySQL to be installed. For example if EDB Postgres Version is 13 and MySQL version is 8 then the package name is `edb-as13-mysql8-fdw`. diff --git a/product_docs/docs/mysql_data_adapter/2/04_installing_the_mysql_data_adapter/x86_amd64/mysql_rhel8_x86.mdx b/product_docs/docs/mysql_data_adapter/2/04_installing_the_mysql_data_adapter/x86_amd64/mysql_rhel8_x86.mdx index 12ec03092a3..5dad2ab5ed2 100644 --- a/product_docs/docs/mysql_data_adapter/2/04_installing_the_mysql_data_adapter/x86_amd64/mysql_rhel8_x86.mdx +++ b/product_docs/docs/mysql_data_adapter/2/04_installing_the_mysql_data_adapter/x86_amd64/mysql_rhel8_x86.mdx @@ -1,64 +1,38 @@ --- -title: "Installing MySQL Foreign Data Wrapper on RHEL 8/OL 8 x86" -navTitle: "RHEL 8/OL 8" +navTitle: RHEL 8 or OL 8 +title: Installing MySQL Foreign Data Wrapper on RHEL 8 or OL 8 x86_64 --- -Before installing the MySQL Foreign Data Wrapper, you must install the following prerequisite packages, and request credentials from EDB: +Before you begin the installation process, log in as superuser. -Install the `epel-release` package: - -```text -dnf -y install https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm +```shell +# To log in as a superuser: +sudo su - ``` -Enable the `codeready-builder-for-rhel-8-\*-rpms` repository: - -```text -ARCH=$( /bin/arch ) -subscription-manager repos --enable "codeready-builder-for-rhel-8-${ARCH}-rpms" -``` +## Set up the repository -You must also have credentials that allow access to the EDB repository. For information about requesting credentials, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request). +Setting up the repository is a one-time task. If you have already set up your repository, you do not need to perform this step. If you do need to set up the repository, you must register with EDB. To receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request). -After receiving your repository credentials you can: +```shell +# Set up the EDB repository: +dnf -y install https://yum.enterprisedb.com/edbrepos/edb-repo-latest.noarch.rpm -1. Create the repository configuration file. -2. Modify the file, providing your user name and password. -3. Install the MySQL Foreign Data Wrapper. +# Replace '' and '' below with +# your username and password for the EDB repository: +sed -i "s@:@USERNAME:PASSWORD@" /etc/yum.repos.d/edb.repo -## Creating a repository configuration file - -To create the repository configuration file, assume superuser privileges, and invoke the following command: - -```text -dnf -y https://yum.enterprisedb.com/edbrepos/edb-repo-latest.noarch.rpm -``` - -The repository configuration file is named `edb.repo`. The file resides in `/etc/yum.repos.d`. - -## Modifying the file, providing your user name and password - -After creating the `edb.repo` file, use your choice of editor to ensure that the value of the `enabled` parameter is `1`, and replace the `username` and `password` placeholders in the `baseurl` specification with the name and password of a registered EDB user. +# Install the EPEL repository: +dnf -y install https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm -```text -[edb] -name=EnterpriseDB RPMs $releasever - $basearch -baseurl=https://:@yum.enterprisedb.com/edb/redhat/rhel-$releasever-$basearch -enabled=1 -gpgcheck=1 -repo_gpgcheck=1 -gpgkey=file:///etc/pki/rpm-gpg/ENTERPRISEDB-GPG-KEY +# Enable additional repositories to resolve dependencies: +ARCH=$( /bin/arch ) subscription-manager repos --enable "codeready-builder-for-rhel-8-${ARCH}-rpms" ``` -## Installing MySQL Foreign Data Wrapper -After saving your changes to the configuration file, use the below command to install the MySQL Foreign Data Wrapper: +## Install the package -```text -dnf install edb-as-mysql8_fdw +```shell +dnf -y install edb-as-mysql-fdw ``` -Where `xx` is the server version number i.e. 13. - -When you install an RPM package that is signed by a source that is not recognized by your system, yum may ask for your permission to import the key to your local server. If prompted, and you are satisfied that the packages come from a trustworthy source, enter `y`, and press `Return` to continue. - -During the installation, yum may encounter a dependency that it cannot resolve. If it does, it will provide a list of the required dependencies that you must manually resolve. +Where `` is the version of EDB Postgres Advanced server and `` is the version of MySQL to be installed. For example if EDB Postgres Version is 13 and MySQL version is 8 then the package name is `edb-as13-mysql8-fdw`. From a31baaf6b62a34b355fde1e9065f6c89b446743e Mon Sep 17 00:00:00 2001 From: nidhibhammar <59045594+nidhibhammar@users.noreply.github.com> Date: Fri, 5 Aug 2022 12:58:54 +0530 Subject: [PATCH 05/16] Generated and deployed the PEM rehdhat install topics --- install_template/deploy.mjs | 20 ++++ .../base.njk | 1 + .../base.njk | 3 + .../centos-7.njk | 8 +- .../rhel-7-or-ol-7.njk | 8 +- .../pem_agent_rhel8_ppcle.mdx | 70 ++++--------- .../x86_amd64/pem_agent_centos7_x86.mdx | 50 ++++------ .../x86_amd64/pem_agent_other_linux8_x86.mdx | 53 +++------- .../x86_amd64/pem_agent_rhel7_x86.mdx | 54 +++-------- .../x86_amd64/pem_agent_rhel8_x86.mdx | 54 +++-------- .../pem_server_rhel8_ppcle.mdx | 97 +++++-------------- .../pem_server_sles12_ppcle.mdx | 4 + .../pem_server_sles15_ppcle.mdx | 4 + .../x86_amd64/pem_server_centos7_x86.mdx | 87 ++++++----------- .../x86_amd64/pem_server_deb10_x86.mdx | 4 + .../x86_amd64/pem_server_other_linux8_x86.mdx | 84 +++++----------- .../x86_amd64/pem_server_rhel7_x86.mdx | 89 +++++------------ .../x86_amd64/pem_server_rhel8_x86.mdx | 81 +++++----------- .../x86_amd64/pem_server_sles12_x86.mdx | 4 + .../x86_amd64/pem_server_sles15_x86.mdx | 4 + .../x86_amd64/pem_server_ubuntu18_x86.mdx | 4 + .../x86_amd64/pem_server_ubuntu20_x86.mdx | 4 + 22 files changed, 272 insertions(+), 515 deletions(-) diff --git a/install_template/deploy.mjs b/install_template/deploy.mjs index 7df16d5f103..01643c10fc4 100644 --- a/install_template/deploy.mjs +++ b/install_template/deploy.mjs @@ -282,6 +282,16 @@ const moveDoc = async (product, platform, version) => { (ctx) => `pgpool/4.3/02_extensions/${fmtArchPath(ctx)}/pgpoolext_ubuntu18_${fmtArchFilename(ctx)}.mdx`), when({product: {name: "EDB Pgpool-II Extensions", version: 4.3}, platform: {name: "Ubuntu 20.04"}}, (ctx) => `pgpool/4.3/02_extensions/${fmtArchPath(ctx)}/pgpoolext_ubuntu20_${fmtArchFilename(ctx)}.mdx`), + when({product: {name: "Postgres Enterprise Manager server", version: 8}, platform: {name: "RHEL 8 or OL 8"}}, + (ctx) => `pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/${fmtArchPath(ctx)}/pem_server_rhel8_${fmtArchFilename(ctx)}.mdx`), + when({product: {name: "Postgres Enterprise Manager server", version: 8}, platform: {name: "RHEL 8"}}, + (ctx) => `pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/${fmtArchPath(ctx)}/pem_server_rhel8_${fmtArchFilename(ctx)}.mdx`), + when({product: {name: "Postgres Enterprise Manager server", version: 8}, platform: {name: "RHEL 7 or OL 7"}}, + (ctx) => `pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/${fmtArchPath(ctx)}/pem_server_rhel7_${fmtArchFilename(ctx)}.mdx`), + when({product: {name: "Postgres Enterprise Manager server", version: 8}, platform: {name: "AlmaLinux 8 or Rocky Linux 8"}}, + (ctx) => `pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/${fmtArchPath(ctx)}/pem_server_other_linux8_${fmtArchFilename(ctx)}.mdx`), + when({product: {name: "Postgres Enterprise Manager server", version: 8}, platform: {name: "CentOS 7"}}, + (ctx) => `pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/${fmtArchPath(ctx)}/pem_server_centos7_${fmtArchFilename(ctx)}.mdx`), when({product: {name: "Postgres Enterprise Manager server", version: 8}, platform: {name: "SLES 15"}}, (ctx) => `pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/${fmtArchPath(ctx)}/pem_server_sles15_${fmtArchFilename(ctx)}.mdx`), when({product: {name: "Postgres Enterprise Manager server", version: 8}, platform: {name: "SLES 12"}}, @@ -292,6 +302,16 @@ const moveDoc = async (product, platform, version) => { (ctx) => `pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/${fmtArchPath(ctx)}/pem_server_ubuntu18_${fmtArchFilename(ctx)}.mdx`), when({product: {name: "Postgres Enterprise Manager server", version: 8}, platform: {name: "Ubuntu 20.04"}}, (ctx) => `pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/${fmtArchPath(ctx)}/pem_server_ubuntu20_${fmtArchFilename(ctx)}.mdx`), + when({product: {name: "Postgres Enterprise Manager agent", version: 8}, platform: {name: "RHEL 8 or OL 8"}}, + (ctx) => `pem/8/installing_pem_agent/installing_on_linux/${fmtArchPath(ctx)}/pem_agent_rhel8_${fmtArchFilename(ctx)}.mdx`), + when({product: {name: "Postgres Enterprise Manager agent", version: 8}, platform: {name: "RHEL 8"}}, + (ctx) => `pem/8/installing_pem_agent/installing_on_linux/${fmtArchPath(ctx)}/pem_agent_rhel8_${fmtArchFilename(ctx)}.mdx`), + when({product: {name: "Postgres Enterprise Manager agent", version: 8}, platform: {name: "RHEL 7 or OL 7"}}, + (ctx) => `pem/8/installing_pem_agent/installing_on_linux/${fmtArchPath(ctx)}/pem_agent_rhel7_${fmtArchFilename(ctx)}.mdx`), + when({product: {name: "Postgres Enterprise Manager agent", version: 8}, platform: {name: "AlmaLinux 8 or Rocky Linux 8"}}, + (ctx) => `pem/8/installing_pem_agent/installing_on_linux/${fmtArchPath(ctx)}/pem_agent_other_linux8_${fmtArchFilename(ctx)}.mdx`), + when({product: {name: "Postgres Enterprise Manager agent", version: 8}, platform: {name: "CentOS 7"}}, + (ctx) => `pem/8/installing_pem_agent/installing_on_linux/${fmtArchPath(ctx)}/pem_agent_centos7_${fmtArchFilename(ctx)}.mdx`), when({product: {name: "Postgres Enterprise Manager agent", version: 8}, platform: {name: "SLES 15"}}, (ctx) => `pem/8/installing_pem_agent/installing_on_linux/${fmtArchPath(ctx)}/pem_agent_sles15_${fmtArchFilename(ctx)}.mdx`), when({product: {name: "Postgres Enterprise Manager agent", version: 8}, platform: {name: "SLES 12"}}, diff --git a/install_template/templates/products/postgres-enterprise-manager-agent/base.njk b/install_template/templates/products/postgres-enterprise-manager-agent/base.njk index c0b158e2e0b..18b387b4f00 100644 --- a/install_template/templates/products/postgres-enterprise-manager-agent/base.njk +++ b/install_template/templates/products/postgres-enterprise-manager-agent/base.njk @@ -1,5 +1,6 @@ {% extends "platformBase/" + platformBaseTemplate + '.njk' %} {% set packageName %}edb-pem-agent{% endset %} +{% block pemsetuprepo %}{% endblock pemsetuprepo %} {% block installCommand %} {{super()}} After installing PEM agent, you need to register the PEM agent. For detailed information see [Registering an agent](/pem/latest/registering_agent/). diff --git a/install_template/templates/products/postgres-enterprise-manager-server/base.njk b/install_template/templates/products/postgres-enterprise-manager-server/base.njk index 79487f50ef3..2c5129d21c9 100644 --- a/install_template/templates/products/postgres-enterprise-manager-server/base.njk +++ b/install_template/templates/products/postgres-enterprise-manager-server/base.njk @@ -19,4 +19,7 @@ sudo su - ``` For more details, see [Configuring the PEM Server on Linux](/pem/latest/installing_pem_server/installing_on_linux/configuring_the_pem_server_on_linux/). + +!!! Note +- The operating system user pem is created while installing the PEM server. The PEM server web application is a WSGI application, which runs under Apache HTTPD. The pem application data and the session is saved to this user's home directory. {% endblock postinstall %} \ No newline at end of file diff --git a/install_template/templates/products/postgres-enterprise-manager-server/centos-7.njk b/install_template/templates/products/postgres-enterprise-manager-server/centos-7.njk index 068544b4cc0..a4fd66e61c1 100644 --- a/install_template/templates/products/postgres-enterprise-manager-server/centos-7.njk +++ b/install_template/templates/products/postgres-enterprise-manager-server/centos-7.njk @@ -1,2 +1,8 @@ {% extends "products/postgres-enterprise-manager-server/base.njk" %} -{% set platformBaseTemplate = "centos-7" %} \ No newline at end of file +{% set platformBaseTemplate = "centos-7" %} +{% block postinstall %} +{{ super() }}!!! Note: +- If you're doing a fresh installation of the PEM server on a CentOS 7.x host, the installer also installs edb-python3-mod_wsgi packages with the installation required by the operating system. + +- If you're upgrading the PEM server on a CentOS 7.x host, the mod_wsgi system package is replaced by the edb-python3-mod_wsgi package as required by the operating system. +{% endblock postinstall %} \ No newline at end of file diff --git a/install_template/templates/products/postgres-enterprise-manager-server/rhel-7-or-ol-7.njk b/install_template/templates/products/postgres-enterprise-manager-server/rhel-7-or-ol-7.njk index 13984173cc3..ee661bbae09 100644 --- a/install_template/templates/products/postgres-enterprise-manager-server/rhel-7-or-ol-7.njk +++ b/install_template/templates/products/postgres-enterprise-manager-server/rhel-7-or-ol-7.njk @@ -1,2 +1,8 @@ {% extends "products/postgres-enterprise-manager-server/base.njk" %} -{% set platformBaseTemplate = "rhel-7-or-ol-7" %} \ No newline at end of file +{% set platformBaseTemplate = "rhel-7-or-ol-7" %} +{% block postinstall %} +{{ super() }} +- If you're doing a fresh installation of the PEM server on a RHEL 7.x host, the installer also installs edb-python3-mod_wsgi packages with the installation required by the operating system. + +- If you're upgrading the PEM server on a RHEL 7.x host, the mod_wsgi system package is replaced by the edb-python3-mod_wsgi package as required by the operating system. +{% endblock postinstall %} \ No newline at end of file diff --git a/product_docs/docs/pem/8/installing_pem_agent/installing_on_linux/ibm_power_ppc64le/pem_agent_rhel8_ppcle.mdx b/product_docs/docs/pem/8/installing_pem_agent/installing_on_linux/ibm_power_ppc64le/pem_agent_rhel8_ppcle.mdx index f9f13eb05bc..7464842e5c6 100644 --- a/product_docs/docs/pem/8/installing_pem_agent/installing_on_linux/ibm_power_ppc64le/pem_agent_rhel8_ppcle.mdx +++ b/product_docs/docs/pem/8/installing_pem_agent/installing_on_linux/ibm_power_ppc64le/pem_agent_rhel8_ppcle.mdx @@ -1,67 +1,33 @@ --- -title: "Installing the PEM agent on RHEL 8 ppc64le" -navTitle: "RHEL 8" +navTitle: RHEL 8 +title: Installing Postgres Enterprise Manager agent on RHEL 8 ppc64le --- - -There are two steps to completing an installation: - -- [Setting up the repository](#setting-up-the-repository) -- [Installing the package](#installing-the-package) - -For each step, you must be logged in as superuser. - -To log in as a superuser: +Before you begin the installation process, log in as superuser. ```shell +# To log in as a superuser: sudo su - ``` -### Setting up the Repository - -1. To register with EDB to receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request). - -1. Set up the EDB repository: - - ```shell - dnf -y install https://yum.enterprisedb.com/edbrepos/edb-repo-latest.noarch.rpm - ``` - - This creates the /etc/yum.repos.d/edb.repo configuration file. - -1. Replace `'USERNAME:PASSWORD'` below with your username and password available from your - [EDB account](https://www.enterprisedb.com/user) in the edb.repo file: +## Set up the repository - ```shell - sed -i "s@:@USERNAME:PASSWORD@" /etc/yum.repos.d/edb.repo - ``` +Setting up the repository is a one-time task. If you have already set up your repository, you do not need to perform this step. If you do need to set up the repository, you must register with EDB. To receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request). -1. Install EPEL repository and refresh the cache: - - ```shell - dnf -y install https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm - dnf makecache - ``` - -1. Enable the codeready-builder-for-rhel-8-\*-rpms repository since EPEL packages may depend on packages from it: - - ```shell - ARCH=$( /bin/arch ) - subscription-manager repos --enable "codeready-builder-for-rhel-8-${ARCH}-rpms" - ``` - -1. Disable the built-in PostgreSQL module: - - ```shell - dnf -qy module disable postgresql - ``` +```shell +# Set up the EDB repository: +dnf -y install https://yum.enterprisedb.com/edbrepos/edb-repo-latest.noarch.rpm -### Installing the Package +# Replace '' and '' below with +# your username and password for the EDB repository: +sed -i "s@:@USERNAME:PASSWORD@" /etc/yum.repos.d/edb.repo - ```shell - dnf -y install edb-pem-agent - ``` +``` -After installing the PEM Agent, you must register the agent. For more detailed information see [Registering an agent](../../../registering_agent). +## Install the package +```shell +dnf -y install edb-pem-agent +``` +After installing PEM agent, you need to register the PEM agent. For detailed information see [Registering an agent](/pem/latest/registering_agent/). diff --git a/product_docs/docs/pem/8/installing_pem_agent/installing_on_linux/x86_amd64/pem_agent_centos7_x86.mdx b/product_docs/docs/pem/8/installing_pem_agent/installing_on_linux/x86_amd64/pem_agent_centos7_x86.mdx index 28c4143004f..ba21444580c 100644 --- a/product_docs/docs/pem/8/installing_pem_agent/installing_on_linux/x86_amd64/pem_agent_centos7_x86.mdx +++ b/product_docs/docs/pem/8/installing_pem_agent/installing_on_linux/x86_amd64/pem_agent_centos7_x86.mdx @@ -1,49 +1,33 @@ --- -title: "Installing the PEM agent on CentOS 7 x86" -navTitle: "CentOS 7" +navTitle: CentOS 7 +title: Installing Postgres Enterprise Manager agent on CentOS 7 x86_64 --- -A PEM Agent may monitor one or more servers on one or more hosts. For comprehensive information about managing a PEM Agent, see the [Managing an agent](../../../managing_pem_agent). - -On a CentOS system, you can use the `yum` package manager to install a PEM Agent; the installation tool you use will be dependent on the version of the host operating system. Before installing the agent, you must ensure that your system contains the required prerequisite software listed below. - -**Install the `epel-release` package** +Before you begin the installation process, log in as superuser. ```shell -yum -y install https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm +# To log in as a superuser: +sudo su - ``` -**Install and Configure the edb.repo File** +## Set up the repository -To create an EDB repository configuration file, assume superuser privileges and invoke the following command: +Setting up the repository is a one-time task. If you have already set up your repository, you do not need to perform this step. If you do need to set up the repository, you must register with EDB. To receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request). ```shell -yum -y install https://yum.enterprisedb.com/edb-repo-rpms/edb-repo-latest.noarch.rpm -``` - -The repository configuration file is named `edb.repo`. The file resides in `/etc/yum.repos.d`. After creating the `edb.repo` file, use the following command to replace the `USERNAME` and `PASSWORD` placeholders in the `baseurl` specification with the <username> and <password> of a registered EDB user: +# Set up the EDB repository: +yum -y install https://yum.enterprisedb.com/edbrepos/edb-repo-latest.noarch.rpm -```shell +# Replace '' and '' below with +# your username and password for the EDB repository: sed -i "s@:@USERNAME:PASSWORD@" /etc/yum.repos.d/edb.repo -``` - -To request credentials for the repository, contact [EDB](https://www.enterprisedb.com/repository-access-request). - -**Installing the PEM Agent** -- Install the PEM Agent package: - - ```shell - yum install edb-pem-agent - ``` - -When the installation is complete, you can review a list of the installed packages and dependencies. - -![](../../../images/pem_rpm_installation_agent.png) - -When you install an RPM package that is signed by a source that is not recognized by your system, yum may ask for your permission to import the key to your local server. If prompted, and you are satisfied that the packages come from a trustworthy source, enter `y`, and press `Return` to continue. +``` -During the installation, yum may encounter a dependency that it cannot resolve. If it does, it will provide a list of the required dependencies that you must manually resolve. +## Install the package -After installing PEM Agent using `yum`, you need to register the PEM Agent. For detailed information see [Registering an agent](../../../registering_agent). +```shell +yum -y install edb-pem-agent +``` +After installing PEM agent, you need to register the PEM agent. For detailed information see [Registering an agent](/pem/latest/registering_agent/). diff --git a/product_docs/docs/pem/8/installing_pem_agent/installing_on_linux/x86_amd64/pem_agent_other_linux8_x86.mdx b/product_docs/docs/pem/8/installing_pem_agent/installing_on_linux/x86_amd64/pem_agent_other_linux8_x86.mdx index 65c29a064b0..4cf3a8eff1a 100644 --- a/product_docs/docs/pem/8/installing_pem_agent/installing_on_linux/x86_amd64/pem_agent_other_linux8_x86.mdx +++ b/product_docs/docs/pem/8/installing_pem_agent/installing_on_linux/x86_amd64/pem_agent_other_linux8_x86.mdx @@ -1,54 +1,33 @@ --- -title: "Installing the PEM agent on Rocky Linux 8/AlmaLinux x86" -navTitle: "Rocky Linux 8/AlmaLinux 8" +navTitle: AlmaLinux 8 or Rocky Linux 8 +title: Installing Postgres Enterprise Manager agent on AlmaLinux 8 or Rocky Linux 8 x86_64 --- -A PEM Agent may monitor one or more servers on one or more hosts. For comprehensive information about managing a PEM Agent, see [Managing an agent](../../../managing_pem_agent). - -On a Rocky Linux or AlmaLinux system, you can use the `dnf` command to install a PEM Agent; the installation tool you use will be dependent on the version of the host operating system. Before installing the agent, you must ensure that your system contains the required prerequisite software listed below. - -**Install the `epel-release` package** +Before you begin the installation process, log in as superuser. ```shell -dnf -y install https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm +# To log in as a superuser: +sudo su - ``` -**Enable the powertools repository since EPEL packages may depend on packages from it** +## Set up the repository -```shell -dnf config-manager --set-enabled powertools -``` +Setting up the repository is a one-time task. If you have already set up your repository, you do not need to perform this step. If you do need to set up the repository, you must register with EDB. To receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request). -**Install and Configure the edb.repo File** +```shell +# Set up the EDB repository: +dnf -y install https://yum.enterprisedb.com/edbrepos/edb-repo-latest.noarch.rpm -To create an EDB repository configuration file, assume superuser privileges and invoke the following command: +# Replace '' and '' below with +# your username and password for the EDB repository: +sed -i "s@:@USERNAME:PASSWORD@" /etc/yum.repos.d/edb.repo -```shell -dnf -y install https://yum.enterprisedb.com/edb-repo-rpms/edb-repo-latest.noarch.rpm ``` -The repository configuration file is named `edb.repo`. The file resides in `/etc/yum.repos.d`. After creating the `edb.repo` file, use the following command to replace the `USERNAME` and `PASSWORD` placeholders in the `baseurl` specification with the <username> and <password> of a registered EDB user: +## Install the package ```shell -sed -i "s@:@USERNAME:PASSWORD@" /etc/yum.repos.d/edb.repo +dnf -y install edb-pem-agent ``` -To request credentials for the repository, contact [EDB](https://www.enterprisedb.com/repository-access-request). - -**Installing the PEM Agent** - -- Install the PEM Agent package: - - ```shell - dnf install edb-pem-agent - ``` - -When the installation is complete, you can review a list of the installed packages and dependencies. - -![](../../../images/pem_rpm_installation_agent.png) - -When you install an RPM package that is signed by a source that is not recognized by your system, yum may ask for your permission to import the key to your local server. If prompted, and you are satisfied that the packages come from a trustworthy source, enter `y`, and press `Return` to continue. - -During the installation, yum may encounter a dependency that it cannot resolve. If it does, it will provide a list of the required dependencies that you must manually resolve. - -After installing PEM Agent using `dnf`, you need to register the PEM Agent. For detailed information see [Registering an agent](../../../registering_agent). +After installing PEM agent, you need to register the PEM agent. For detailed information see [Registering an agent](/pem/latest/registering_agent/). diff --git a/product_docs/docs/pem/8/installing_pem_agent/installing_on_linux/x86_amd64/pem_agent_rhel7_x86.mdx b/product_docs/docs/pem/8/installing_pem_agent/installing_on_linux/x86_amd64/pem_agent_rhel7_x86.mdx index ed9a0766e1b..3ce8ea0fba7 100644 --- a/product_docs/docs/pem/8/installing_pem_agent/installing_on_linux/x86_amd64/pem_agent_rhel7_x86.mdx +++ b/product_docs/docs/pem/8/installing_pem_agent/installing_on_linux/x86_amd64/pem_agent_rhel7_x86.mdx @@ -1,57 +1,33 @@ --- -title: "Installing the PEM agent on RHEL 7/OL 7 x86" -navTitle: "RHEL 7/OL 7" +navTitle: RHEL 7 or OL 7 +title: Installing Postgres Enterprise Manager agent on RHEL 7 or OL 7 x86_64 --- -A PEM Agent may monitor one or more servers on one or more hosts. For comprehensive information about managing a PEM Agent, see [Managing an agent](../../../managing_pem_agent). - -On a RHEL or OL system, you can use the `yum` package manager to install a PEM Agent; the installation tool you use will be dependent on the version of the host operating system. Before installing the agent, you must ensure that your system contains the required prerequisite software listed below. - -**Install the `epel-release` package** +Before you begin the installation process, log in as superuser. ```shell -yum -y install https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm +# To log in as a superuser: +sudo su - ``` -**If you are a Red Hat Network user** +## Set up the repository -Enable the optional, extras, and HA repositories since EPEL packages may depend on packages from these repositories +Setting up the repository is a one-time task. If you have already set up your repository, you do not need to perform this step. If you do need to set up the repository, you must register with EDB. To receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request). ```shell -subscription-manager repos --enable "rhel-*-optional-rpms" --enable "rhel-*-extras-rpms" --enable "rhel-ha-for-rhel-*-server-rpms" -``` - -**Install and Configure the edb.repo File** +# Set up the EDB repository: +yum -y install https://yum.enterprisedb.com/edbrepos/edb-repo-latest.noarch.rpm -To create an EDB repository configuration file, assume superuser privileges and invoke the following command: +# Replace '' and '' below with +# your username and password for the EDB repository: +sed -i "s@:@USERNAME:PASSWORD@" /etc/yum.repos.d/edb.repo -```shell -yum -y install https://yum.enterprisedb.com/edb-repo-rpms/edb-repo-latest.noarch.rpm ``` -The repository configuration file is named `edb.repo`. The file resides in `/etc/yum.repos.d`. After creating the `edb.repo` file, use the following command to replace the `USERNAME` and `PASSWORD` placeholders in the `baseurl` specification with the <username> and <password> of a registered EDB user: +## Install the package ```shell -sed -i "s@:@USERNAME:PASSWORD@" /etc/yum.repos.d/edb.repo +yum -y install edb-pem-agent ``` -To request credentials for the repository, contact [EDB](https://www.enterprisedb.com/repository-access-request). - -**Installing the PEM Agent** - -- Install the PEM Agent package: - - ```shell - yum install edb-pem-agent - ``` - -When the installation is complete, you can review a list of the installed packages and dependencies. - -![](../../../images/pem_rpm_installation_agent.png) - -When you install an RPM package that is signed by a source that is not recognized by your system, yum may ask for your permission to import the key to your local server. If prompted, and you are satisfied that the packages come from a trustworthy source, enter `y`, and press `Return` to continue. - -During the installation, yum may encounter a dependency that it cannot resolve. If it does, it will provide a list of the required dependencies that you must manually resolve. - -After installing PEM Agent using `yum`, you need to register the PEM Agent. For detailed information see [Registering an agent](../../../registering_agent). - +After installing PEM agent, you need to register the PEM agent. For detailed information see [Registering an agent](/pem/latest/registering_agent/). diff --git a/product_docs/docs/pem/8/installing_pem_agent/installing_on_linux/x86_amd64/pem_agent_rhel8_x86.mdx b/product_docs/docs/pem/8/installing_pem_agent/installing_on_linux/x86_amd64/pem_agent_rhel8_x86.mdx index 3647bccbfe4..4622a33ee8c 100644 --- a/product_docs/docs/pem/8/installing_pem_agent/installing_on_linux/x86_amd64/pem_agent_rhel8_x86.mdx +++ b/product_docs/docs/pem/8/installing_pem_agent/installing_on_linux/x86_amd64/pem_agent_rhel8_x86.mdx @@ -1,57 +1,33 @@ --- -title: "Installing the PEM agent on RHEL 8/OL 8 x86" -navTitle: "RHEL 8/OL 8" +navTitle: RHEL 8 or OL 8 +title: Installing Postgres Enterprise Manager agent on RHEL 8 or OL 8 x86_64 --- -A PEM Agent may monitor one or more servers on one or more hosts. For comprehensive information about managing a PEM Agent, see [Managing an agent](../../../managing_pem_agent). - -On a RHEL or OL system, you can use the `dnf` command to install a PEM Agent; the installation tool you use will be dependent on the version of the host operating system. Before installing the agent, you must ensure that your system contains the required prerequisite software listed below. - -**Install the `epel-release` package** +Before you begin the installation process, log in as superuser. ```shell -dnf -y install https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm +# To log in as a superuser: +sudo su - ``` -**If you are a Red Hat Network user** +## Set up the repository -Enable the codeready-builder-for-rhel-8-*-rpms repository since EPEL packages may depend on packages from it +Setting up the repository is a one-time task. If you have already set up your repository, you do not need to perform this step. If you do need to set up the repository, you must register with EDB. To receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request). ```shell -ARCH=$( /bin/arch ) -subscription-manager repos --enable "codeready-builder-for-rhel-8-${ARCH}-rpms" -``` - -**Install and Configure the edb.repo File** +# Set up the EDB repository: +dnf -y install https://yum.enterprisedb.com/edbrepos/edb-repo-latest.noarch.rpm -To create an EDB repository configuration file, assume superuser privileges and invoke the following command: +# Replace '' and '' below with +# your username and password for the EDB repository: +sed -i "s@:@USERNAME:PASSWORD@" /etc/yum.repos.d/edb.repo -```shell -dnf -y install https://yum.enterprisedb.com/edb-repo-rpms/edb-repo-latest.noarch.rpm ``` -The repository configuration file is named `edb.repo`. The file resides in `/etc/yum.repos.d`. After creating the `edb.repo` file, use the following command to replace the `USERNAME` and `PASSWORD` placeholders in the `baseurl` specification with the `` and `` of a registered EDB user: +## Install the package ```shell -sed -i "s@:@USERNAME:PASSWORD@" /etc/yum.repos.d/edb.repo +dnf -y install edb-pem-agent ``` -To request credentials for the repository, contact [EDB](https://www.enterprisedb.com/repository-access-request). - -**Installing the PEM Agent** - -- Install the PEM Agent package: - - ```shell - dnf install edb-pem-agent - ``` - -When the installation is complete, you can review a list of the installed packages and dependencies. - -![](../../../images/pem_rpm_installation_agent.png) - -When you install an RPM package that is signed by a source that is not recognized by your system, yum may ask for your permission to import the key to your local server. If prompted, and you are satisfied that the packages come from a trustworthy source, enter `y`, and press `Return` to continue. - -During the installation, yum may encounter a dependency that it cannot resolve. If it does, it will provide a list of the required dependencies that you must manually resolve. - -After installing PEM Agent using `dnf`, you need to register the PEM Agent. For detailed information see [Registering an agent](../../../registering_agent). +After installing PEM agent, you need to register the PEM agent. For detailed information see [Registering an agent](/pem/latest/registering_agent/). diff --git a/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/ibm_power_ppc64le/pem_server_rhel8_ppcle.mdx b/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/ibm_power_ppc64le/pem_server_rhel8_ppcle.mdx index 53398538d89..ab543ec2e27 100644 --- a/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/ibm_power_ppc64le/pem_server_rhel8_ppcle.mdx +++ b/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/ibm_power_ppc64le/pem_server_rhel8_ppcle.mdx @@ -1,94 +1,47 @@ --- -title: "Installing the PEM server on RHEL 8 ppc64le" -navTitle: "RHEL 8" +navTitle: RHEL 8 +title: Installing Postgres Enterprise Manager server on RHEL 8 ppc64le --- -Before you begin the installation process, log in as superuser: +Before you begin the installation process: + +1. Review the [prerequisites](/pem/latest/installing_pem_server/installing_on_linux/prerequisites/). + +2. Log in as superuser: ```shell -# To log in as a superuser: sudo su - ``` -## Prerequisites - -- Postres Enterprise Manager requires a Postgres server running either [EDB Postgres Advanced Server](/epas/latest) or [PostgresSQL](/supported-open-source/postgresql/) version 11 or later to hold the Postgres Enterprise Manager backend database. - - 1. Install the Postgres server. See [Installing EDB Postgres Advanced Server on Linux](/epas/latest/epas_inst_linux) or [Installing PostgreSQL](/supported-open-source/postgresql/installer/). - - 2. Configure authentication on the Postgres server by updating the pg_hba.conf file. The pg_hba.conf file manages connections. You must ensure that the pg_hba.conf file allows connections from the PEM server, the monitoring PEM agent, and the host of the Apache web server server. - - - If you are using EDB Postgres Advanced Server, see [Modifying the pg_hba.conf file](/pem/latest/managing_database_server/#modifying-the-pg_hbaconf-file). - - - If you are using PostgreSQL, see [Client Authentication](https://www.postgresql.org/docs/current/auth-pg-hba-conf.html). - - 3. Ensure that the `sslutils` extension and `hstore` contrib module are installed on your Postgres server. - - - If you are using EDB Postgres Advanced Server, the `sslutils` extension and `hstore` contrib module are installed by default. - - - If you are PostgreSQL, ensure you have access to the PostgreSQL community repository, and then install the `sslutils` extension and the `hstore` contrib module: - - ```shell - dnf install postgresql-_sslutils postgresql-contrib - ``` - - Where, `x` is the Postgres server version. - - 4. If you are using a firewall, allow access to port `8443` on the Postgres server: - - ```shell - firewall-cmd --permanent --zone=public --add-port=8443/tcp - - firewall-cmd --reload - ``` - -- Ensure the components Postgres Enterprise Manager depends on such as python3, libboost, openssl (1.0.2k or later), snmp++, and libcurl are up to date, using the following command: - - ```shell - dnf upgrade - ``` +## Set up the repository -### Setting up the Repository +Setting up the repository is a one-time task. If you have already set up your repository, you do not need to perform this step. If you do need to set up the repository, you must register with EDB. To receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request). -1. To register with EDB to receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request). - -1. Set up the EDB repository: - - ```shell - dnf -y install https://yum.enterprisedb.com/edbrepos/edb-repo-latest.noarch.rpm - ``` - - This creates the /etc/yum.repos.d/edb.repo configuration file. - -1. Replace `'USERNAME:PASSWORD'` below with your username and password available from your - [EDB account](https://www.enterprisedb.com/user) in the edb.repo file: - - ```shell - sed -i "s@:@USERNAME:PASSWORD@" /etc/yum.repos.d/edb.repo - ``` - -1. Disable the built-in PostgreSQL module: - - ```shell - dnf -qy module disable postgresql - ``` +```shell +# Set up the EDB repository: +dnf -y install https://yum.enterprisedb.com/edbrepos/edb-repo-latest.noarch.rpm -### Installing the Package +# Replace '' and '' below with +# your username and password for the EDB repository: +sed -i "s@:@USERNAME:PASSWORD@" /etc/yum.repos.d/edb.repo - ```shell - dnf -y install edb-pem - ``` +``` -!!! Note - The operating system user `pem` gets created while installing the PEM Server. The PEM Server web application is a WSGI application, which runs under Apache HTTPD. The pem application data and the session gets saved to this user's home directory. +## Install the package +```shell +dnf -y install edb-pem +``` -## Initial Configuration +## Initial configuration ```shell # You can configure the PEM server using the following command: /usr/edb/pem/bin/configure-pem-server.sh ``` -For more details, see [Configuring the PEM Server on Linux](../../configuring_the_pem_server_on_linux/). +For more details, see [Configuring the PEM Server on Linux](/pem/latest/installing_pem_server/installing_on_linux/configuring_the_pem_server_on_linux/). + +!!! Note +- The operating system user pem is created while installing the PEM server. The PEM server web application is a WSGI application, which runs under Apache HTTPD. The pem application data and the session is saved to this user's home directory. diff --git a/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/ibm_power_ppc64le/pem_server_sles12_ppcle.mdx b/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/ibm_power_ppc64le/pem_server_sles12_ppcle.mdx index 963d89568eb..3a3a4c63256 100644 --- a/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/ibm_power_ppc64le/pem_server_sles12_ppcle.mdx +++ b/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/ibm_power_ppc64le/pem_server_sles12_ppcle.mdx @@ -53,3 +53,7 @@ zypper -n install edb-pem ``` For more details, see [Configuring the PEM Server on Linux](/pem/latest/installing_pem_server/installing_on_linux/configuring_the_pem_server_on_linux/). + +!!! Note + +- The operating system user pem is created while installing the PEM server. The PEM server web application is a WSGI application, which runs under Apache HTTPD. The pem application data and the session is saved to this user's home directory. diff --git a/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/ibm_power_ppc64le/pem_server_sles15_ppcle.mdx b/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/ibm_power_ppc64le/pem_server_sles15_ppcle.mdx index 73d9a285af4..30dc4344106 100644 --- a/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/ibm_power_ppc64le/pem_server_sles15_ppcle.mdx +++ b/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/ibm_power_ppc64le/pem_server_sles15_ppcle.mdx @@ -52,3 +52,7 @@ zypper -n install edb-pem ``` For more details, see [Configuring the PEM Server on Linux](/pem/latest/installing_pem_server/installing_on_linux/configuring_the_pem_server_on_linux/). + +!!! Note + +- The operating system user pem is created while installing the PEM server. The PEM server web application is a WSGI application, which runs under Apache HTTPD. The pem application data and the session is saved to this user's home directory. diff --git a/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_centos7_x86.mdx b/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_centos7_x86.mdx index b20cf14e43b..0a73ff30984 100644 --- a/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_centos7_x86.mdx +++ b/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_centos7_x86.mdx @@ -1,84 +1,51 @@ --- -title: "Installing the PEM server on CentOS 7 x86" -navTitle: "CentOS 7" +navTitle: CentOS 7 +title: Installing Postgres Enterprise Manager server on CentOS 7 x86_64 --- -On a CentOS system, you can use the `yum` package manager to install a PEM Server; the installation tool you use will be dependent on the version of the host operating system. Before installing the server, you must ensure that your system contains the required prerequisite software listed below. +Before you begin the installation process: -## Prerequisites +1. Review the [prerequisites](/pem/latest/installing_pem_server/installing_on_linux/prerequisites/). -- Postres Enterprise Manager requires a Postgres server running either [EDB Postgres Advanced Server](/epas/latest) or [PostgresSQL](/supported-open-source/postgresql/) version 11 or later to hold the Postgres Enterprise Manager backend database. - - 1. Install the Postgres server. See [Installing EDB Postgres Advanced Server on Linux](/epas/latest/epas_inst_linux) or [Installing PostgreSQL](/supported-open-source/postgresql/installer/). - - 2. Configure authentication on the Postgres server by updating the pg_hba.conf file. The pg_hba.conf file manages connections. You must ensure that the pg_hba.conf file allows connections from the PEM server, the monitoring PEM agent, and the host of the Apache web server server. - - - If you are using EDB Postgres Advanced Server, see [Modifying the pg_hba.conf file](/pem/latest/managing_database_server/#modifying-the-pg_hbaconf-file). +2. Log in as superuser: - - If you are using PostgreSQL, see [Client Authentication](https://www.postgresql.org/docs/current/auth-pg-hba-conf.html). - - 3. Ensure that the `sslutils` extension and `hstore` contrib module are installed on your Postgres server. - - - If you are using EDB Postgres Advanced Server, the `sslutils` extension and `hstore` contrib module are installed by default. - - - If you are PostgreSQL, ensure you have access to the PostgreSQL community repository, and then install the `sslutils` extension and the `hstore` contrib module: - - ```shell - yum install postgresql-_sslutils postgresql-contrib - ``` - - Where, `x` is the Postgres server version. - - 4. If you are using a firewall, allow access to port `8443` on the Postgres server: - - ```shell - firewall-cmd --permanent --zone=public --add-port=8443/tcp - - firewall-cmd --reload - ``` +```shell +sudo su - +``` -- Ensure the components Postgres Enterprise Manager depends on such as python3, libboost, openssl (1.0.2k or later), snmp++, and libcurl are up to date, using the following command: +## Set up the repository - ```shell - yum upgrade - ``` +Setting up the repository is a one-time task. If you have already set up your repository, you do not need to perform this step. If you do need to set up the repository, you must register with EDB. To receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request). -## Install and configure the edb.repo file +```shell +# Set up the EDB repository: +yum -y install https://yum.enterprisedb.com/edbrepos/edb-repo-latest.noarch.rpm -To create an EnterpriseDB repository configuration file, assume superuser privileges and invoke the following command: +# Replace '' and '' below with +# your username and password for the EDB repository: +sed -i "s@:@USERNAME:PASSWORD@" /etc/yum.repos.d/edb.repo -```shell -yum -y install https://yum.enterprisedb.com/edb-repo-rpms/edb-repo-latest.noarch.rpm ``` -The repository configuration file is named `edb.repo`. The file resides in `/etc/yum.repos.d`. After creating the `edb.repo` file, use the following command to replace the `USERNAME` and `PASSWORD` placeholders in the `baseurl` specification with the `` and `` of a registered EDB user: +## Install the package ```shell -sed -i "s@:@USERNAME:PASSWORD@" /etc/yum.repos.d/edb.repo +yum -y install edb-pem ``` -To request credentials for the repository, contact [EDB](https://www.enterprisedb.com/repository-access-request). - -## Install the PEM Server - -After meeting the platform-specific prerequisites listed above, you can use yum to install the PEM Server: +## Initial configuration ```shell -yum install edb-pem +# You can configure the PEM server using the following command: +/usr/edb/pem/bin/configure-pem-server.sh ``` -!!! Note - The operating system user `pem` gets created while installing the PEM Server. The PEM Server web application is a WSGI application, which runs under Apache HTTPD. The pem application data and the session gets saved to this user's home directory. - -If you are doing a fresh installation of the PEM Server on a CentOS 7.x host, the installer will also install `edb-python3-mod_wsgi` packages along with the installation as per requirement of the operating system. - -If you are upgrading the PEM Server on a CentOS 7.x host, the `mod_wsgi system` package will be replaced by the `edb-python3-mod_wsgi` package as per the requirement of the operating system. - -When you install an RPM package that is signed by a source that is not recognized by your system, yum may ask for your permission to import the key to your local server. If prompted, and you are satisfied that the packages come from a trustworthy source, enter `y`, and press `Return` to continue. +For more details, see [Configuring the PEM Server on Linux](/pem/latest/installing_pem_server/installing_on_linux/configuring_the_pem_server_on_linux/). -During the installation, yum may encounter a dependency that it cannot resolve. If it does, it will provide a list of the required dependencies that you must manually resolve. - -If you want to install PEM server on a machine that is in isolated network, you must first create PEM repository on that machine. For more information about creating PEM repository on an isolated network, see [Creating a PEM repository in an Isolated Network](../../creating_pem_repository_in_isolated_network/). +!!! Note -After installing PEM Server using `yum`, you need to configure the PEM Server. For more detailed information see [Configuring the PEM Server on Linux platforms](../../configuring_the_pem_server_on_linux/). +- The operating system user pem is created while installing the PEM server. The PEM server web application is a WSGI application, which runs under Apache HTTPD. The pem application data and the session is saved to this user's home directory. + !!! Note: +- If you're doing a fresh installation of the PEM server on a CentOS 7.x host, the installer also installs edb-python3-mod_wsgi packages with the installation required by the operating system. +- If you're upgrading the PEM server on a CentOS 7.x host, the mod_wsgi system package is replaced by the edb-python3-mod_wsgi package as required by the operating system. diff --git a/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_deb10_x86.mdx b/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_deb10_x86.mdx index a428d267681..9f245748bb9 100644 --- a/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_deb10_x86.mdx +++ b/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_deb10_x86.mdx @@ -50,3 +50,7 @@ apt-get install edb-pem ``` For more details, see [Configuring the PEM Server on Linux](/pem/latest/installing_pem_server/installing_on_linux/configuring_the_pem_server_on_linux/). + +!!! Note + +- The operating system user pem is created while installing the PEM server. The PEM server web application is a WSGI application, which runs under Apache HTTPD. The pem application data and the session is saved to this user's home directory. diff --git a/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_other_linux8_x86.mdx b/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_other_linux8_x86.mdx index dcf718db9a2..db81fd071b2 100644 --- a/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_other_linux8_x86.mdx +++ b/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_other_linux8_x86.mdx @@ -1,85 +1,47 @@ --- -title: "Installing the PEM server on Rocky Linux 8/AlmaLinux 8 x86" -navTitle: "Rocky Linux 8/AlmaLinux 8" +navTitle: AlmaLinux 8 or Rocky Linux 8 +title: Installing Postgres Enterprise Manager server on AlmaLinux 8 or Rocky Linux 8 x86_64 --- -On a Rocky Linux or AlmaLinux system, you can use the `yum` package manager or `dnf` command to install a PEM Server; the installation tool you use will be dependent on the version of the host operating system. Before installing the server, you must ensure that your system contains the required prerequisite software listed below. +Before you begin the installation process: -## Prerequisites +1. Review the [prerequisites](/pem/latest/installing_pem_server/installing_on_linux/prerequisites/). -- Postres Enterprise Manager requires a Postgres server running either [EDB Postgres Advanced Server](/epas/latest) or [PostgresSQL](/supported-open-source/postgresql/) version 11 or later to hold the Postgres Enterprise Manager backend database. - - 1. Install the Postgres server. See [Installing EDB Postgres Advanced Server on Linux](/epas/latest/epas_inst_linux) or [Installing PostgreSQL](/supported-open-source/postgresql/installer/). - - 2. Configure authentication on the Postgres server by updating the pg_hba.conf file. The pg_hba.conf file manages connections. You must ensure that the pg_hba.conf file allows connections from the PEM server, the monitoring PEM agent, and the host of the Apache web server server. - - - If you are using EDB Postgres Advanced Server, see [Modifying the pg_hba.conf file](/pem/latest/managing_database_server/#modifying-the-pg_hbaconf-file). - - - If you are using PostgreSQL, see [Client Authentication](https://www.postgresql.org/docs/current/auth-pg-hba-conf.html). - - 3. Ensure that the `sslutils` extension and `hstore` contrib module are installed on your Postgres server. - - - If you are using EDB Postgres Advanced Server, the `sslutils` extension and `hstore` contrib module are installed by default. - - - If you are PostgreSQL, ensure you have access to the PostgreSQL community repository, and then install the `sslutils` extension and the `hstore` contrib module: - - ```shell - dnf install postgresql-_sslutils postgresql-contrib - ``` - - Where, `x` is the Postgres server version. - - 4. If you are using a firewall, allow access to port `8443` on the Postgres server: - - ```shell - firewall-cmd --permanent --zone=public --add-port=8443/tcp - - firewall-cmd --reload - ``` - -- Ensure the components Postgres Enterprise Manager depends on such as python3, libboost, openssl (1.0.2k or later), snmp++, and libcurl are up to date, using the following command: - - ```shell - dnf upgrade - ``` - -## Install and configure the edb.repo file - -To create an EnterpriseDB repository configuration file, assume superuser privileges and invoke the following command: +2. Log in as superuser: ```shell -dnf -y install https://yum.enterprisedb.com/edb-repo-rpms/edb-repo-latest.noarch.rpm +sudo su - ``` -The repository configuration file is named `edb.repo`. The file resides in `/etc/yum.repos.d`. After creating the `edb.repo` file, use the following command to replace the `USERNAME` and `PASSWORD` placeholders in the `baseurl` specification with the `` and `` of a registered EDB user: +## Set up the repository + +Setting up the repository is a one-time task. If you have already set up your repository, you do not need to perform this step. If you do need to set up the repository, you must register with EDB. To receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request). ```shell +# Set up the EDB repository: +dnf -y install https://yum.enterprisedb.com/edbrepos/edb-repo-latest.noarch.rpm + +# Replace '' and '' below with +# your username and password for the EDB repository: sed -i "s@:@USERNAME:PASSWORD@" /etc/yum.repos.d/edb.repo -``` -To request credentials for the repository, contact [EDB](https://www.enterprisedb.com/repository-access-request). +``` -## Disable the built-in PostgreSQL module +## Install the package ```shell -dnf -qy module disable PostgreSQL +dnf -y install edb-pem ``` -## Install the PEM server - -After meeting the platform-specific prerequisites listed above, you can use dnf to install the PEM Server: +## Initial configuration ```shell -dnf install edb-pem +# You can configure the PEM server using the following command: +/usr/edb/pem/bin/configure-pem-server.sh ``` -!!! Note - The operating system user `pem` gets created while installing the PEM Server. The PEM Server web application is a WSGI application, which runs under Apache HTTPD. The pem application data and the session gets saved to this user's home directory. - -When you install an RPM package that is signed by a source that is not recognized by your system, yum may ask for your permission to import the key to your local server. If prompted, and you are satisfied that the packages come from a trustworthy source, enter `y`, and press `Return` to continue. +For more details, see [Configuring the PEM Server on Linux](/pem/latest/installing_pem_server/installing_on_linux/configuring_the_pem_server_on_linux/). -During the installation, yum may encounter a dependency that it cannot resolve. If it does, it will provide a list of the required dependencies that you must manually resolve. - -If you want to install PEM server on a machine that is in isolated network, you must first create PEM repository on that machine. For more information about creating PEM repository on an isolated network, see [Creating a PEM repository in an Isolated Network](../../creating_pem_repository_in_isolated_network/). +!!! Note -After installing PEM Server using `yum` or `dnf`, you need to configure the PEM Server. For more detailed information see [Configuring the PEM Server on Linux platforms](../../configuring_the_pem_server_on_linux/). +- The operating system user pem is created while installing the PEM server. The PEM server web application is a WSGI application, which runs under Apache HTTPD. The pem application data and the session is saved to this user's home directory. diff --git a/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_rhel7_x86.mdx b/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_rhel7_x86.mdx index 3c674eaf82c..d4b6b217646 100644 --- a/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_rhel7_x86.mdx +++ b/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_rhel7_x86.mdx @@ -1,88 +1,51 @@ --- -title: "Installing the PEM server on RHEL 7/OL 7 x86" -navTitle: "RHEL 7/OL 7" +navTitle: RHEL 7 or OL 7 +title: Installing Postgres Enterprise Manager server on RHEL 7 or OL 7 x86_64 --- -Before following the detailed instructions that install the PEM server on your specific platform, you must perform the prerequisite steps detailed in [Prerequisites](#prerequisites). +Before you begin the installation process: -On a RHEL or OL system, you can use the `yum` package manager to install a PEM Server; the installation tool you use will be dependent on the version of the host operating system. Before installing the server, you must ensure that your system contains the required prerequisite software listed below. +1. Review the [prerequisites](/pem/latest/installing_pem_server/installing_on_linux/prerequisites/). -## Prerequisites +2. Log in as superuser: -- Postres Enterprise Manager requires a Postgres server running either [EDB Postgres Advanced Server](/epas/latest) or [PostgresSQL](/supported-open-source/postgresql/) version 11 or later to hold the Postgres Enterprise Manager backend database. - - 1. Install the Postgres server. See [Installing EDB Postgres Advanced Server on Linux](/epas/latest/epas_inst_linux) or [Installing PostgreSQL](/supported-open-source/postgresql/installer/). - - 2. Configure authentication on the Postgres server by updating the pg_hba.conf file. The pg_hba.conf file manages connections. You must ensure that the pg_hba.conf file allows connections from the PEM server, the monitoring PEM agent, and the host of the Apache web server server. - - - If you are using EDB Postgres Advanced Server, see [Modifying the pg_hba.conf file](/pem/latest/managing_database_server/#modifying-the-pg_hbaconf-file). - - - If you are using PostgreSQL, see [Client Authentication](https://www.postgresql.org/docs/current/auth-pg-hba-conf.html). - - 3. Ensure that the `sslutils` extension and `hstore` contrib module are installed on your Postgres server. - - - If you are using EDB Postgres Advanced Server, the `sslutils` extension and `hstore` contrib module are installed by default. - - - If you are PostgreSQL, ensure you have access to the PostgreSQL community repository, and then install the `sslutils` extension and the `hstore` contrib module: - - ```shell - yum install postgresql-_sslutils postgresql-contrib - ``` - - Where, `x` is the Postgres server version. - - 4. If you are using a firewall, allow access to port `8443` on the Postgres server: - - ```shell - firewall-cmd --permanent --zone=public --add-port=8443/tcp - - firewall-cmd --reload - ``` - -- Ensure the components Postgres Enterprise Manager depends on such as python3, libboost, openssl (1.0.2k or later), snmp++, and libcurl are up to date, using the following command: - - ```shell - yum upgrade - ``` +```shell +sudo su - +``` +## Set up the repository +Setting up the repository is a one-time task. If you have already set up your repository, you do not need to perform this step. If you do need to set up the repository, you must register with EDB. To receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request). -## Install and configure the edb.repo file +```shell +# Set up the EDB repository: +yum -y install https://yum.enterprisedb.com/edbrepos/edb-repo-latest.noarch.rpm -To create an EnterpriseDB repository configuration file, assume superuser privileges and invoke the following command: +# Replace '' and '' below with +# your username and password for the EDB repository: +sed -i "s@:@USERNAME:PASSWORD@" /etc/yum.repos.d/edb.repo -```shell -yum -y install https://yum.enterprisedb.com/edb-repo-rpms/edb-repo-latest.noarch.rpm ``` -The repository configuration file is named `edb.repo`. The file resides in `/etc/yum.repos.d`. After creating the `edb.repo` file, use the following command to replace the `USERNAME` and `PASSWORD` placeholders in the `baseurl` specification with the `` and `` of a registered EDB user: +## Install the package ```shell -sed -i "s@:@USERNAME:PASSWORD@" /etc/yum.repos.d/edb.repo +yum -y install edb-pem ``` -To request credentials for the repository, contact [EDB](https://www.enterprisedb.com/repository-access-request). - -## Install the PEM server - -After meeting the platform-specific prerequisites listed above, you can use yum to install the PEM Server: +## Initial configuration ```shell -yum install edb-pem +# You can configure the PEM server using the following command: +/usr/edb/pem/bin/configure-pem-server.sh ``` -!!! Note - The operating system user `pem` gets created while installing the PEM Server. The PEM Server web application is a WSGI application, which runs under Apache HTTPD. The pem application data and the session gets saved to this user's home directory. - -If you are doing a fresh installation of the PEM Server on a RHEL 7.x host, the installer will also install `edb-python3-mod_wsgi` packages along with the installation as per requirement of the operating system. - -If you are upgrading the PEM Server on a RHEL 7.x host, the `mod_wsgi system` package will be replaced by the `edb-python3-mod_wsgi` package as per the requirement of the operating system. +For more details, see [Configuring the PEM Server on Linux](/pem/latest/installing_pem_server/installing_on_linux/configuring_the_pem_server_on_linux/). -When you install an RPM package that is signed by a source that is not recognized by your system, yum may ask for your permission to import the key to your local server. If prompted, and you are satisfied that the packages come from a trustworthy source, enter `y`, and press `Return` to continue. - -During the installation, yum may encounter a dependency that it cannot resolve. If it does, it will provide a list of the required dependencies that you must manually resolve. +!!! Note -If you want to install PEM server on a machine that is in isolated network, you must first create PEM repository on that machine. For more information about creating PEM repository on an isolated network, see [Creating a PEM repository in an Isolated Network](../../creating_pem_repository_in_isolated_network/). +- The operating system user pem is created while installing the PEM server. The PEM server web application is a WSGI application, which runs under Apache HTTPD. The pem application data and the session is saved to this user's home directory. -After installing PEM Server using `yum`, you need to configure the PEM Server. For more detailed information see [Configuring the PEM Server on Linux platforms](../../configuring_the_pem_server_on_linux/). +- If you're doing a fresh installation of the PEM server on a RHEL 7.x host, the installer also installs edb-python3-mod_wsgi packages with the installation required by the operating system. +- If you're upgrading the PEM server on a RHEL 7.x host, the mod_wsgi system package is replaced by the edb-python3-mod_wsgi package as required by the operating system. diff --git a/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_rhel8_x86.mdx b/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_rhel8_x86.mdx index 285fec65c2b..ed6f3c7a2b5 100644 --- a/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_rhel8_x86.mdx +++ b/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_rhel8_x86.mdx @@ -1,80 +1,47 @@ --- -title: "Installing the PEM server on RHEL 8/OL 8 x86" -navTitle: "RHEL 8/OL 8 x86" +navTitle: RHEL 8 or OL 8 +title: Installing Postgres Enterprise Manager server on RHEL 8 or OL 8 x86_64 --- -On a RHEL or OL system, you can use the `dnf` command to install a PEM Server; the installation tool you use will be dependent on the version of the host operating system. Before installing the server, you must ensure that your system contains the required prerequisite software listed below. +Before you begin the installation process: -## Prerequisites +1. Review the [prerequisites](/pem/latest/installing_pem_server/installing_on_linux/prerequisites/). -- Postres Enterprise Manager requires a Postgres server running either [EDB Postgres Advanced Server](/epas/latest) or [PostgresSQL](/supported-open-source/postgresql/) version 11 or later to hold the Postgres Enterprise Manager backend database. - - 1. Install the Postgres server. See [Installing EDB Postgres Advanced Server on Linux](/epas/latest/epas_inst_linux) or [Installing PostgreSQL](/supported-open-source/postgresql/installer/). - - 2. Configure authentication on the Postgres server by updating the pg_hba.conf file. The pg_hba.conf file manages connections. You must ensure that the pg_hba.conf file allows connections from the PEM server, the monitoring PEM agent, and the host of the Apache web server server. - - - If you are using EDB Postgres Advanced Server, see [Modifying the pg_hba.conf file](/pem/latest/managing_database_server/#modifying-the-pg_hbaconf-file). +2. Log in as superuser: - - If you are using PostgreSQL, see [Client Authentication](https://www.postgresql.org/docs/current/auth-pg-hba-conf.html). - - 3. Ensure that the `sslutils` extension and `hstore` contrib module are installed on your Postgres server. - - - If you are using EDB Postgres Advanced Server, the `sslutils` extension and `hstore` contrib module are installed by default. - - - If you are PostgreSQL, ensure you have access to the PostgreSQL community repository, and then install the `sslutils` extension and the `hstore` contrib module: - - ```shell - dnf install postgresql-_sslutils postgresql-contrib - ``` - - Where, `x` is the Postgres server version. - - 4. If you are using a firewall, allow access to port `8443` on the Postgres server: - - ```shell - firewall-cmd --permanent --zone=public --add-port=8443/tcp - - firewall-cmd --reload - ``` - -- Ensure the components Postgres Enterprise Manager depends on such as python3, libboost, openssl (1.0.2k or later), snmp++, and libcurl are up to date, using the following command: +```shell +sudo su - +``` - ```shell - dnf upgrade - ``` +## Set up the repository +Setting up the repository is a one-time task. If you have already set up your repository, you do not need to perform this step. If you do need to set up the repository, you must register with EDB. To receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request). -## Install and configure the edb.repo file +```shell +# Set up the EDB repository: +dnf -y install https://yum.enterprisedb.com/edbrepos/edb-repo-latest.noarch.rpm -To create an EnterpriseDB repository configuration file, assume superuser privileges and invoke the following command: +# Replace '' and '' below with +# your username and password for the EDB repository: +sed -i "s@:@USERNAME:PASSWORD@" /etc/yum.repos.d/edb.repo -```shell -dnf -y install https://yum.enterprisedb.com/edb-repo-rpms/edb-repo-latest.noarch.rpm ``` -The repository configuration file is named `edb.repo`. The file resides in `/etc/yum.repos.d`. After creating the `edb.repo` file, use the following command to replace the `USERNAME` and `PASSWORD` placeholders in the `baseurl` specification with the `` and `` of a registered EDB user: +## Install the package ```shell -sed -i "s@:@USERNAME:PASSWORD@" /etc/yum.repos.d/edb.repo +dnf -y install edb-pem ``` -To request credentials for the repository, contact [EDB](https://www.enterprisedb.com/repository-access-request). - -## Install the PEM server - -After meeting the platform-specific prerequisites listed above, you can use dnf to install the PEM Server: +## Initial configuration ```shell -dnf install edb-pem +# You can configure the PEM server using the following command: +/usr/edb/pem/bin/configure-pem-server.sh ``` -!!! Note - The operating system user `pem` gets created while installing the PEM Server. The PEM Server web application is a WSGI application, which runs under Apache HTTPD. The pem application data and the session gets saved to this user's home directory. - -When you install an RPM package that is signed by a source that is not recognized by your system, yum may ask for your permission to import the key to your local server. If prompted, and you are satisfied that the packages come from a trustworthy source, enter `y`, and press `Return` to continue. +For more details, see [Configuring the PEM Server on Linux](/pem/latest/installing_pem_server/installing_on_linux/configuring_the_pem_server_on_linux/). -During the installation, yum may encounter a dependency that it cannot resolve. If it does, it will provide a list of the required dependencies that you must manually resolve. - -If you want to install PEM server on a machine that is in isolated network, you must first create PEM repository on that machine. For more information about creating PEM repository on an isolated network, see [Creating a PEM repository in an Isolated Network](../../creating_pem_repository_in_isolated_network/). +!!! Note -After installing PEM Server using `yum` or `dnf`, you need to configure the PEM Server. For more detailed information see [Configuring the PEM Server on Linux platforms](../../configuring_the_pem_server_on_linux/). +- The operating system user pem is created while installing the PEM server. The PEM server web application is a WSGI application, which runs under Apache HTTPD. The pem application data and the session is saved to this user's home directory. diff --git a/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_sles12_x86.mdx b/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_sles12_x86.mdx index 0da2b94bcb5..117285bdccf 100644 --- a/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_sles12_x86.mdx +++ b/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_sles12_x86.mdx @@ -53,3 +53,7 @@ zypper -n install edb-pem ``` For more details, see [Configuring the PEM Server on Linux](/pem/latest/installing_pem_server/installing_on_linux/configuring_the_pem_server_on_linux/). + +!!! Note + +- The operating system user pem is created while installing the PEM server. The PEM server web application is a WSGI application, which runs under Apache HTTPD. The pem application data and the session is saved to this user's home directory. diff --git a/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_sles15_x86.mdx b/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_sles15_x86.mdx index 74c2c90c851..139be855bf5 100644 --- a/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_sles15_x86.mdx +++ b/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_sles15_x86.mdx @@ -52,3 +52,7 @@ zypper -n install edb-pem ``` For more details, see [Configuring the PEM Server on Linux](/pem/latest/installing_pem_server/installing_on_linux/configuring_the_pem_server_on_linux/). + +!!! Note + +- The operating system user pem is created while installing the PEM server. The PEM server web application is a WSGI application, which runs under Apache HTTPD. The pem application data and the session is saved to this user's home directory. diff --git a/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_ubuntu18_x86.mdx b/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_ubuntu18_x86.mdx index 55c6f6e8be5..8bc737a3767 100644 --- a/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_ubuntu18_x86.mdx +++ b/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_ubuntu18_x86.mdx @@ -50,3 +50,7 @@ apt-get install edb-pem ``` For more details, see [Configuring the PEM Server on Linux](/pem/latest/installing_pem_server/installing_on_linux/configuring_the_pem_server_on_linux/). + +!!! Note + +- The operating system user pem is created while installing the PEM server. The PEM server web application is a WSGI application, which runs under Apache HTTPD. The pem application data and the session is saved to this user's home directory. diff --git a/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_ubuntu20_x86.mdx b/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_ubuntu20_x86.mdx index d4d76362a11..73fe6ef71fb 100644 --- a/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_ubuntu20_x86.mdx +++ b/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_ubuntu20_x86.mdx @@ -50,3 +50,7 @@ apt-get install edb-pem ``` For more details, see [Configuring the PEM Server on Linux](/pem/latest/installing_pem_server/installing_on_linux/configuring_the_pem_server_on_linux/). + +!!! Note + +- The operating system user pem is created while installing the PEM server. The PEM server web application is a WSGI application, which runs under Apache HTTPD. The pem application data and the session is saved to this user's home directory. From 15b153f4d80c9267acd0eb426d10bfcf8efcbeaa Mon Sep 17 00:00:00 2001 From: nidhibhammar <59045594+nidhibhammar@users.noreply.github.com> Date: Wed, 10 Aug 2022 14:33:55 +0530 Subject: [PATCH 06/16] Updated as per the Dee Dee's comment --- .../ibm_power_ppc64le/pem_server_rhel8_ppcle.mdx | 7 +++---- .../ibm_power_ppc64le/pem_server_sles12_ppcle.mdx | 7 +++---- .../ibm_power_ppc64le/pem_server_sles15_ppcle.mdx | 7 +++---- .../x86_amd64/index.mdx | 3 +-- .../x86_amd64/pem_server_centos7_x86.mdx | 12 ++++++------ .../x86_amd64/pem_server_deb10_x86.mdx | 7 +++---- .../x86_amd64/pem_server_other_linux8_x86.mdx | 7 +++---- .../x86_amd64/pem_server_rhel7_x86.mdx | 11 +++++------ .../x86_amd64/pem_server_rhel8_x86.mdx | 7 +++---- .../x86_amd64/pem_server_sles12_x86.mdx | 7 +++---- .../x86_amd64/pem_server_sles15_x86.mdx | 7 +++---- .../x86_amd64/pem_server_ubuntu18_x86.mdx | 7 +++---- .../x86_amd64/pem_server_ubuntu20_x86.mdx | 7 +++---- 13 files changed, 42 insertions(+), 54 deletions(-) diff --git a/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/ibm_power_ppc64le/pem_server_rhel8_ppcle.mdx b/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/ibm_power_ppc64le/pem_server_rhel8_ppcle.mdx index b34459945ec..c2640ef4e89 100644 --- a/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/ibm_power_ppc64le/pem_server_rhel8_ppcle.mdx +++ b/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/ibm_power_ppc64le/pem_server_rhel8_ppcle.mdx @@ -5,7 +5,7 @@ title: Installing Postgres Enterprise Manager server on RHEL 8 ppc64le Before you begin the installation process: -1. Review the [prerequisites](/pem/latest/installing_pem_server/installing_on_linux/prerequisites/). +1. Review the [prerequisites](/pem/latest/installing_pem_server/pem_server_inst_linux/prerequisites/). 2. Log in as superuser: @@ -40,9 +40,8 @@ dnf -y install edb-pem /usr/edb/pem/bin/configure-pem-server.sh ``` -For more details, see [Configuring the PEM Server on Linux](/pem/latest/installing_pem_server/installing_on_linux/configuring_the_pem_server_on_linux/). +For more details, see [Configuring the PEM Server on Linux](/pem/latest/installing_pem_server/pem_server_inst_linux/configuring_the_pem_server_on_linux/). !!! Note - -- The operating system user pem is created while installing the PEM server. The PEM server web application is a WSGI application, which runs under Apache HTTPD. The pem application data and the session is saved to this user's home directory. + - The operating system user pem is created while installing the PEM server. The PEM server web application is a WSGI application, which runs under Apache HTTPD. The pem application data and the session is saved to this user's home directory. diff --git a/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/ibm_power_ppc64le/pem_server_sles12_ppcle.mdx b/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/ibm_power_ppc64le/pem_server_sles12_ppcle.mdx index 3a3a4c63256..9a337d65d76 100644 --- a/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/ibm_power_ppc64le/pem_server_sles12_ppcle.mdx +++ b/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/ibm_power_ppc64le/pem_server_sles12_ppcle.mdx @@ -5,7 +5,7 @@ title: Installing Postgres Enterprise Manager server on SLES 12 ppc64le Before you begin the installation process: -1. Review the [prerequisites](/pem/latest/installing_pem_server/installing_on_linux/prerequisites/). +1. Review the [prerequisites](/pem/latest/installing_pem_server/pem_server_inst_linux/prerequisites/). 2. Log in as superuser: @@ -52,8 +52,7 @@ zypper -n install edb-pem /usr/edb/pem/bin/configure-pem-server.sh ``` -For more details, see [Configuring the PEM Server on Linux](/pem/latest/installing_pem_server/installing_on_linux/configuring_the_pem_server_on_linux/). +For more details, see [Configuring the PEM Server on Linux](/pem/latest/installing_pem_server/pem_server_inst_linux/configuring_the_pem_server_on_linux/). !!! Note - -- The operating system user pem is created while installing the PEM server. The PEM server web application is a WSGI application, which runs under Apache HTTPD. The pem application data and the session is saved to this user's home directory. + - The operating system user pem is created while installing the PEM server. The PEM server web application is a WSGI application, which runs under Apache HTTPD. The pem application data and the session is saved to this user's home directory. diff --git a/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/ibm_power_ppc64le/pem_server_sles15_ppcle.mdx b/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/ibm_power_ppc64le/pem_server_sles15_ppcle.mdx index 30dc4344106..dd996675ec7 100644 --- a/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/ibm_power_ppc64le/pem_server_sles15_ppcle.mdx +++ b/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/ibm_power_ppc64le/pem_server_sles15_ppcle.mdx @@ -5,7 +5,7 @@ title: Installing Postgres Enterprise Manager server on SLES 15 ppc64le Before you begin the installation process: -1. Review the [prerequisites](/pem/latest/installing_pem_server/installing_on_linux/prerequisites/). +1. Review the [prerequisites](/pem/latest/installing_pem_server/pem_server_inst_linux/prerequisites/). 2. Log in as superuser: @@ -51,8 +51,7 @@ zypper -n install edb-pem /usr/edb/pem/bin/configure-pem-server.sh ``` -For more details, see [Configuring the PEM Server on Linux](/pem/latest/installing_pem_server/installing_on_linux/configuring_the_pem_server_on_linux/). +For more details, see [Configuring the PEM Server on Linux](/pem/latest/installing_pem_server/pem_server_inst_linux/configuring_the_pem_server_on_linux/). !!! Note - -- The operating system user pem is created while installing the PEM server. The PEM server web application is a WSGI application, which runs under Apache HTTPD. The pem application data and the session is saved to this user's home directory. + - The operating system user pem is created while installing the PEM server. The PEM server web application is a WSGI application, which runs under Apache HTTPD. The pem application data and the session is saved to this user's home directory. diff --git a/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/index.mdx b/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/index.mdx index fadefa02226..fffede13f40 100644 --- a/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/index.mdx +++ b/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/index.mdx @@ -12,7 +12,6 @@ navigation: - pem_server_ubuntu20_x86 - pem_server_ubuntu18_x86 - pem_server_deb10_x86 -- pem_server_deb9_x86 --- For Linux x86-64 (amd64), see: @@ -26,4 +25,4 @@ For Linux x86-64 (amd64), see: - [Ubuntu 20.04](pem_server_ubuntu20_x86) - [Ubuntu 18.04](pem_server_ubuntu18_x86) - [Debian 10](pem_server_deb10_x86) - - [Debian 9](pem_server_deb9_x86) + diff --git a/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_centos7_x86.mdx b/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_centos7_x86.mdx index 74401a3a1bd..fbe1f476d4c 100644 --- a/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_centos7_x86.mdx +++ b/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_centos7_x86.mdx @@ -6,7 +6,7 @@ title: Installing Postgres Enterprise Manager server on CentOS 7 x86_64 Before you begin the installation process: -1. Review the [prerequisites](/pem/latest/installing_pem_server/installing_on_linux/prerequisites/). +1. Review the [prerequisites](/pem/latest/installing_pem_server/pem_server_inst_linux/prerequisites/). 2. Log in as superuser: @@ -41,12 +41,12 @@ yum -y install edb-pem /usr/edb/pem/bin/configure-pem-server.sh ``` -For more details, see [Configuring the PEM Server on Linux](/pem/latest/installing_pem_server/installing_on_linux/configuring_the_pem_server_on_linux/). +For more details, see [Configuring the PEM Server on Linux](/pem/latest/installing_pem_server/pem_server_inst_linux/configuring_the_pem_server_on_linux/). -!!! Note -- The operating system user pem is created while installing the PEM server. The PEM server web application is a WSGI application, which runs under Apache HTTPD. The pem application data and the session is saved to this user's home directory. +!!! Note + - The operating system user pem is created while installing the PEM server. The PEM server web application is a WSGI application, which runs under Apache HTTPD. The pem application data and the session is saved to this user's home directory. -- If you're doing a fresh installation of the PEM server on a CentOS 7.x host, the installer also installs edb-python3-mod_wsgi packages with the installation required by the operating system. + - If you're doing a fresh installation of the PEM server on a CentOS 7.x host, the installer also installs edb-python3-mod_wsgi packages with the installation required by the operating system. -- If you're upgrading the PEM server on a CentOS 7.x host, the mod_wsgi system package is replaced by the edb-python3-mod_wsgi package as required by the operating system. + - If you're upgrading the PEM server on a CentOS 7.x host, the mod_wsgi system package is replaced by the edb-python3-mod_wsgi package as required by the operating system. \ No newline at end of file diff --git a/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_deb10_x86.mdx b/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_deb10_x86.mdx index 9f245748bb9..340684683e2 100644 --- a/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_deb10_x86.mdx +++ b/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_deb10_x86.mdx @@ -5,7 +5,7 @@ title: Installing Postgres Enterprise Manager server on Debian 10 x86_64 Before you begin the installation process: -1. Review the [prerequisites](/pem/latest/installing_pem_server/installing_on_linux/prerequisites/). +1. Review the [prerequisites](/pem/latest/installing_pem_server/pem_server_inst_linux/prerequisites/). 2. Log in as superuser: @@ -49,8 +49,7 @@ apt-get install edb-pem /usr/edb/pem/bin/configure-pem-server.sh ``` -For more details, see [Configuring the PEM Server on Linux](/pem/latest/installing_pem_server/installing_on_linux/configuring_the_pem_server_on_linux/). +For more details, see [Configuring the PEM Server on Linux](/pem/latest/installing_pem_server/pem_server_inst_linux/configuring_the_pem_server_on_linux/). !!! Note - -- The operating system user pem is created while installing the PEM server. The PEM server web application is a WSGI application, which runs under Apache HTTPD. The pem application data and the session is saved to this user's home directory. + - The operating system user pem is created while installing the PEM server. The PEM server web application is a WSGI application, which runs under Apache HTTPD. The pem application data and the session is saved to this user's home directory. diff --git a/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_other_linux8_x86.mdx b/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_other_linux8_x86.mdx index 3c65dc2ad7a..c301340b49f 100644 --- a/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_other_linux8_x86.mdx +++ b/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_other_linux8_x86.mdx @@ -5,7 +5,7 @@ title: Installing Postgres Enterprise Manager server on AlmaLinux 8 or Rocky Lin Before you begin the installation process: -1. Review the [prerequisites](/pem/latest/installing_pem_server/installing_on_linux/prerequisites/). +1. Review the [prerequisites](/pem/latest/installing_pem_server/pem_server_inst_linux/prerequisites/). 2. Log in as superuser: @@ -39,8 +39,7 @@ dnf -y install edb-pem /usr/edb/pem/bin/configure-pem-server.sh ``` -For more details, see [Configuring the PEM Server on Linux](/pem/latest/installing_pem_server/installing_on_linux/configuring_the_pem_server_on_linux/). +For more details, see [Configuring the PEM Server on Linux](/pem/latest/installing_pem_server/pem_server_inst_linux/configuring_the_pem_server_on_linux/). !!! Note - -- The operating system user pem is created while installing the PEM server. The PEM server web application is a WSGI application, which runs under Apache HTTPD. The pem application data and the session is saved to this user's home directory. + - The operating system user pem is created while installing the PEM server. The PEM server web application is a WSGI application, which runs under Apache HTTPD. The pem application data and the session is saved to this user's home directory. diff --git a/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_rhel7_x86.mdx b/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_rhel7_x86.mdx index 5aeaffbdabf..b3e0899624f 100644 --- a/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_rhel7_x86.mdx +++ b/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_rhel7_x86.mdx @@ -5,7 +5,7 @@ title: Installing Postgres Enterprise Manager server on RHEL 7 or OL 7 x86_64 Before you begin the installation process: -1. Review the [prerequisites](/pem/latest/installing_pem_server/installing_on_linux/prerequisites/). +1. Review the [prerequisites](/pem/latest/installing_pem_server/pem_server_inst_linux/prerequisites/). 2. Log in as superuser: @@ -40,12 +40,11 @@ yum -y install edb-pem /usr/edb/pem/bin/configure-pem-server.sh ``` -For more details, see [Configuring the PEM Server on Linux](/pem/latest/installing_pem_server/installing_on_linux/configuring_the_pem_server_on_linux/). +For more details, see [Configuring the PEM Server on Linux](/pem/latest/installing_pem_server/pem_server_inst_linux/configuring_the_pem_server_on_linux/). !!! Note + - The operating system user pem is created while installing the PEM server. The PEM server web application is a WSGI application, which runs under Apache HTTPD. The pem application data and the session is saved to this user's home directory. -- The operating system user pem is created while installing the PEM server. The PEM server web application is a WSGI application, which runs under Apache HTTPD. The pem application data and the session is saved to this user's home directory. + - If you're doing a fresh installation of the PEM server on a RHEL 7.x host, the installer also installs edb-python3-mod_wsgi packages with the installation required by the operating system. -- If you're doing a fresh installation of the PEM server on a RHEL 7.x host, the installer also installs edb-python3-mod_wsgi packages with the installation required by the operating system. - -- If you're upgrading the PEM server on a RHEL 7.x host, the mod_wsgi system package is replaced by the edb-python3-mod_wsgi package as required by the operating system. + - If you're upgrading the PEM server on a RHEL 7.x host, the mod_wsgi system package is replaced by the edb-python3-mod_wsgi package as required by the operating system. diff --git a/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_rhel8_x86.mdx b/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_rhel8_x86.mdx index a6b8798bca5..a0799d618bd 100644 --- a/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_rhel8_x86.mdx +++ b/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_rhel8_x86.mdx @@ -5,7 +5,7 @@ title: Installing Postgres Enterprise Manager server on RHEL 8 or OL 8 x86_64 Before you begin the installation process: -1. Review the [prerequisites](/pem/latest/installing_pem_server/installing_on_linux/prerequisites/). +1. Review the [prerequisites](/pem/latest/installing_pem_server/pem_server_inst_linux/prerequisites/). 2. Log in as superuser: @@ -40,8 +40,7 @@ dnf -y install edb-pem /usr/edb/pem/bin/configure-pem-server.sh ``` -For more details, see [Configuring the PEM Server on Linux](/pem/latest/installing_pem_server/installing_on_linux/configuring_the_pem_server_on_linux/). +For more details, see [Configuring the PEM Server on Linux](/pem/latest/installing_pem_server/pem_server_inst_linux/configuring_the_pem_server_on_linux/). !!! Note - -- The operating system user pem is created while installing the PEM server. The PEM server web application is a WSGI application, which runs under Apache HTTPD. The pem application data and the session is saved to this user's home directory. + - The operating system user pem is created while installing the PEM server. The PEM server web application is a WSGI application, which runs under Apache HTTPD. The pem application data and the session is saved to this user's home directory. diff --git a/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_sles12_x86.mdx b/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_sles12_x86.mdx index 117285bdccf..b7337a9000c 100644 --- a/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_sles12_x86.mdx +++ b/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_sles12_x86.mdx @@ -5,7 +5,7 @@ title: Installing Postgres Enterprise Manager server on SLES 12 x86_64 Before you begin the installation process: -1. Review the [prerequisites](/pem/latest/installing_pem_server/installing_on_linux/prerequisites/). +1. Review the [prerequisites](/pem/latest/installing_pem_server/pem_server_inst_linux/prerequisites/). 2. Log in as superuser: @@ -52,8 +52,7 @@ zypper -n install edb-pem /usr/edb/pem/bin/configure-pem-server.sh ``` -For more details, see [Configuring the PEM Server on Linux](/pem/latest/installing_pem_server/installing_on_linux/configuring_the_pem_server_on_linux/). +For more details, see [Configuring the PEM Server on Linux](/pem/latest/installing_pem_server/pem_server_inst_linux/configuring_the_pem_server_on_linux/). !!! Note - -- The operating system user pem is created while installing the PEM server. The PEM server web application is a WSGI application, which runs under Apache HTTPD. The pem application data and the session is saved to this user's home directory. + - The operating system user pem is created while installing the PEM server. The PEM server web application is a WSGI application, which runs under Apache HTTPD. The pem application data and the session is saved to this user's home directory. diff --git a/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_sles15_x86.mdx b/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_sles15_x86.mdx index 139be855bf5..c5bc25a9a99 100644 --- a/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_sles15_x86.mdx +++ b/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_sles15_x86.mdx @@ -5,7 +5,7 @@ title: Installing Postgres Enterprise Manager server on SLES 15 x86_64 Before you begin the installation process: -1. Review the [prerequisites](/pem/latest/installing_pem_server/installing_on_linux/prerequisites/). +1. Review the [prerequisites](/pem/latest/installing_pem_server/pem_server_inst_linux/prerequisites/). 2. Log in as superuser: @@ -51,8 +51,7 @@ zypper -n install edb-pem /usr/edb/pem/bin/configure-pem-server.sh ``` -For more details, see [Configuring the PEM Server on Linux](/pem/latest/installing_pem_server/installing_on_linux/configuring_the_pem_server_on_linux/). +For more details, see [Configuring the PEM Server on Linux](/pem/latest/installing_pem_server/pem_server_inst_linux/configuring_the_pem_server_on_linux/). !!! Note - -- The operating system user pem is created while installing the PEM server. The PEM server web application is a WSGI application, which runs under Apache HTTPD. The pem application data and the session is saved to this user's home directory. + - The operating system user pem is created while installing the PEM server. The PEM server web application is a WSGI application, which runs under Apache HTTPD. The pem application data and the session is saved to this user's home directory. diff --git a/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_ubuntu18_x86.mdx b/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_ubuntu18_x86.mdx index 8bc737a3767..c641149abf5 100644 --- a/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_ubuntu18_x86.mdx +++ b/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_ubuntu18_x86.mdx @@ -5,7 +5,7 @@ title: Installing Postgres Enterprise Manager server on Ubuntu 18.04 x86_64 Before you begin the installation process: -1. Review the [prerequisites](/pem/latest/installing_pem_server/installing_on_linux/prerequisites/). +1. Review the [prerequisites](/pem/latest/installing_pem_server/pem_server_inst_linux/prerequisites/). 2. Log in as superuser: @@ -49,8 +49,7 @@ apt-get install edb-pem /usr/edb/pem/bin/configure-pem-server.sh ``` -For more details, see [Configuring the PEM Server on Linux](/pem/latest/installing_pem_server/installing_on_linux/configuring_the_pem_server_on_linux/). +For more details, see [Configuring the PEM Server on Linux](/pem/latest/installing_pem_server/pem_server_inst_linux/configuring_the_pem_server_on_linux/). !!! Note - -- The operating system user pem is created while installing the PEM server. The PEM server web application is a WSGI application, which runs under Apache HTTPD. The pem application data and the session is saved to this user's home directory. + - The operating system user pem is created while installing the PEM server. The PEM server web application is a WSGI application, which runs under Apache HTTPD. The pem application data and the session is saved to this user's home directory. diff --git a/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_ubuntu20_x86.mdx b/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_ubuntu20_x86.mdx index 73fe6ef71fb..d1d4dd7ce5d 100644 --- a/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_ubuntu20_x86.mdx +++ b/product_docs/docs/pem/8/installing_pem_server/pem_server_inst_linux/installing_pem_server_using_edb_repository/x86_amd64/pem_server_ubuntu20_x86.mdx @@ -5,7 +5,7 @@ title: Installing Postgres Enterprise Manager server on Ubuntu 20.04 x86_64 Before you begin the installation process: -1. Review the [prerequisites](/pem/latest/installing_pem_server/installing_on_linux/prerequisites/). +1. Review the [prerequisites](/pem/latest/installing_pem_server/pem_server_inst_linux/prerequisites/). 2. Log in as superuser: @@ -49,8 +49,7 @@ apt-get install edb-pem /usr/edb/pem/bin/configure-pem-server.sh ``` -For more details, see [Configuring the PEM Server on Linux](/pem/latest/installing_pem_server/installing_on_linux/configuring_the_pem_server_on_linux/). +For more details, see [Configuring the PEM Server on Linux](/pem/latest/installing_pem_server/pem_server_inst_linux/configuring_the_pem_server_on_linux/). !!! Note - -- The operating system user pem is created while installing the PEM server. The PEM server web application is a WSGI application, which runs under Apache HTTPD. The pem application data and the session is saved to this user's home directory. + - The operating system user pem is created while installing the PEM server. The PEM server web application is a WSGI application, which runs under Apache HTTPD. The pem application data and the session is saved to this user's home directory. From 2c3613f76c8812a7bfaab9f60c24856a1db03459 Mon Sep 17 00:00:00 2001 From: nidhibhammar <59045594+nidhibhammar@users.noreply.github.com> Date: Wed, 10 Aug 2022 17:00:47 +0530 Subject: [PATCH 07/16] Develop - install build fixes --- install_template/config.yaml | 112 ++++++++---------- .../edb-jdbc-connector/centos-7_ppc64le.njk | 2 - .../rhel-7-or-ol-7_ppc64le.njk | 2 - .../edb-jdbc-connector/rhel-8_ppc64le.njk | 2 + .../edb-ocl-connector/centos-7_ppc64le.njk | 2 - .../rhel-7-or-ol-7_ppc64le.njk | 2 - .../edb-ocl-connector/rhel-8_ppc64le.njk | 2 + .../edb-odbc-connector/centos-7_ppc64le.njk | 2 - .../rhel-7-or-ol-7_ppc64le.njk | 2 - .../edb-odbc-connector/rhel-8_ppc64le.njk | 2 + .../edb-pgbouncer/centos-7_ppc64le.njk | 2 - .../edb-pgbouncer/rhel-7-or-ol-7_ppc64le.njk | 2 - .../products/edb-pgbouncer/rhel-8_ppc64le.njk | 2 + .../centos-7_ppc64le.njk | 2 - .../rhel-7-or-ol-7_ppc64le.njk | 2 - .../rhel-8_ppc64le.njk | 2 + .../edb-pgpool-ii/centos-7_ppc64le.njk | 2 - .../products/edb-pgpool-ii/debian-9.njk | 2 - .../edb-pgpool-ii/rhel-7-or-ol-7_ppc64le.njk | 2 - .../products/edb-pgpool-ii/rhel-8_ppc64le.njk | 2 + .../migration-toolkit/centos-7_ppc64le.njk | 2 - .../migration-toolkit/rhel-7_ppc64le.njk | 2 - .../migration-toolkit/rhel-8_ppc64le.njk | 2 + 23 files changed, 64 insertions(+), 92 deletions(-) delete mode 100644 install_template/templates/products/edb-jdbc-connector/centos-7_ppc64le.njk delete mode 100644 install_template/templates/products/edb-jdbc-connector/rhel-7-or-ol-7_ppc64le.njk create mode 100644 install_template/templates/products/edb-jdbc-connector/rhel-8_ppc64le.njk delete mode 100644 install_template/templates/products/edb-ocl-connector/centos-7_ppc64le.njk delete mode 100644 install_template/templates/products/edb-ocl-connector/rhel-7-or-ol-7_ppc64le.njk create mode 100644 install_template/templates/products/edb-ocl-connector/rhel-8_ppc64le.njk delete mode 100644 install_template/templates/products/edb-odbc-connector/centos-7_ppc64le.njk delete mode 100644 install_template/templates/products/edb-odbc-connector/rhel-7-or-ol-7_ppc64le.njk create mode 100644 install_template/templates/products/edb-odbc-connector/rhel-8_ppc64le.njk delete mode 100644 install_template/templates/products/edb-pgbouncer/centos-7_ppc64le.njk delete mode 100644 install_template/templates/products/edb-pgbouncer/rhel-7-or-ol-7_ppc64le.njk create mode 100644 install_template/templates/products/edb-pgbouncer/rhel-8_ppc64le.njk delete mode 100644 install_template/templates/products/edb-pgpool-ii-extensions/centos-7_ppc64le.njk delete mode 100644 install_template/templates/products/edb-pgpool-ii-extensions/rhel-7-or-ol-7_ppc64le.njk create mode 100644 install_template/templates/products/edb-pgpool-ii-extensions/rhel-8_ppc64le.njk delete mode 100644 install_template/templates/products/edb-pgpool-ii/centos-7_ppc64le.njk delete mode 100644 install_template/templates/products/edb-pgpool-ii/debian-9.njk delete mode 100644 install_template/templates/products/edb-pgpool-ii/rhel-7-or-ol-7_ppc64le.njk create mode 100644 install_template/templates/products/edb-pgpool-ii/rhel-8_ppc64le.njk delete mode 100644 install_template/templates/products/migration-toolkit/centos-7_ppc64le.njk delete mode 100644 install_template/templates/products/migration-toolkit/rhel-7_ppc64le.njk create mode 100644 install_template/templates/products/migration-toolkit/rhel-8_ppc64le.njk diff --git a/install_template/config.yaml b/install_template/config.yaml index 5010953c0e0..2b6ba714d95 100644 --- a/install_template/config.yaml +++ b/install_template/config.yaml @@ -10,13 +10,13 @@ products: - name: AlmaLinux 8 or Rocky Linux 8 arch: x86_64 supported versions: [42.x.x] - - name: RHEL 7 + - name: RHEL 7 or OL 7 arch: x86_64 supported versions: [42.x.x] - - name: RHEL 8 + - name: RHEL 8 or OL 8 arch: x86_64 supported versions: [42.x.x] - - name: Ubuntu 20.04 or Debian 10 + - name: Debian 10 arch: x86_64 supported versions: [42.3.3.1] - name: Ubuntu 18.04 @@ -86,13 +86,10 @@ products: - name: AlmaLinux 8 or Rocky Linux 8 arch: x86_64 supported versions: [14.1.0.1] - - name: RHEL 7 - arch: x86_64 - supported versions: [14.1.0.1] - - name: RHEL 8 + - name: RHEL 7 or OL 7 arch: x86_64 supported versions: [14.1.0.1] - - name: Ubuntu 18.04 + - name: RHEL 8 or OL 8 arch: x86_64 supported versions: [14.1.0.1] - name: Debian 10 @@ -127,13 +124,10 @@ products: - name: AlmaLinux 8 or Rocky Linux 8 arch: x86_64 supported versions: [13.1.0.2] - - name: RHEL 7 - arch: x86_64 - supported versions: [13.1.0.2] - - name: RHEL 8 + - name: RHEL 7 or OL 7 arch: x86_64 supported versions: [13.1.0.2] - - name: Ubuntu 18.04 + - name: RHEL 8 or OL 8 arch: x86_64 supported versions: [13.1.0.2] - name: Debian 10 @@ -161,72 +155,66 @@ products: platforms: - name: CentOS 7 arch: x86_64 - supported versions: [1.14, 1.15, 1.16] + supported versions: [1.17] - name: RHEL 8 arch: ppc64le - supported versions: [1.14, 1.15, 1.16] + supported versions: [1.17] - name: AlmaLinux 8 or Rocky Linux 8 arch: x86_64 - supported versions: [1.14, 1.15, 1.16] - - name: RHEL 7 - arch: x86_64 - supported versions: [1.14, 1.15, 1.16] - - name: RHEL 8 + supported versions: [1.17] + - name: RHEL 7 or OL 7 arch: x86_64 - supported versions: [1.14, 1.15, 1.16] - - name: Ubuntu 18.04 + supported versions: [1.17] + - name: RHEL 8 or OL 8 arch: x86_64 - supported versions: [1.14, 1.15, 1.16] + supported versions: [1.17] - name: Debian 10 arch: x86_64 - supported versions: [1.14, 1.15, 1.16] + supported versions: [1.17] - name: Ubuntu 18.04 arch: x86_64 - supported versions: [1.14, 1.15, 1.16] + supported versions: [1.17] - name: Ubuntu 20.04 arch: x86_64 - supported versions: [1.14, 1.15, 1.16] + supported versions: [1.17] - name: SLES 12 arch: x86_64 - supported versions: [1.16] + supported versions: [1.17] - name: SLES 12 arch: ppc64le - supported versions: [1.16] + supported versions: [1.17] - name: SLES 15 arch: x86_64 - supported versions: [1.16] + supported versions: [1.17] - name: SLES 15 arch: ppc64le - supported versions: [1.16] + supported versions: [1.17] - name: EDB Pgpool-II platforms: - name: CentOS 7 arch: x86_64 - supported versions: [4.0, 4.1, 4.2, 4.3] + supported versions: [4.3] - name: RHEL 8 arch: ppc64le - supported versions: [4.0, 4.1, 4.2, 4.3] + supported versions: [4.3] - name: AlmaLinux 8 or Rocky Linux 8 arch: x86_64 - supported versions: [4.0, 4.1, 4.2, 4.3] - - name: RHEL 7 - arch: x86_64 - supported versions: [4.0, 4.1, 4.2, 4.3] - - name: RHEL 8 + supported versions: [4.3] + - name: RHEL 7 or OL 7 arch: x86_64 - supported versions: [4.0, 4.1, 4.2, 4.3] - - name: Ubuntu 18.04 + supported versions: [4.3] + - name: RHEL 8 or OL 8 arch: x86_64 - supported versions: [4.0, 4.1, 4.2, 4.3] + supported versions: [4.3] - name: Debian 10 arch: x86_64 - supported versions: [4.0, 4.1, 4.2, 4.3] + supported versions: [4.3] - name: Ubuntu 18.04 arch: x86_64 - supported versions: [4.0, 4.1, 4.2, 4.3] + supported versions: [4.3] - name: Ubuntu 20.04 arch: x86_64 - supported versions: [4.0, 4.1, 4.2, 4.3] + supported versions: [4.3] - name: SLES 12 arch: x86_64 supported versions: [4.3] @@ -243,31 +231,28 @@ products: platforms: - name: CentOS 7 arch: x86_64 - supported versions: [4.0, 4.1, 4.2, 4.3] + supported versions: [4.3] - name: RHEL 8 arch: ppc64le - supported versions: [4.0, 4.1, 4.2, 4.3] + supported versions: [4.3] - name: AlmaLinux 8 or Rocky Linux 8 arch: x86_64 - supported versions: [4.0, 4.1, 4.2, 4.3] - - name: RHEL 7 - arch: x86_64 - supported versions: [4.0, 4.1, 4.2, 4.3] - - name: RHEL 8 + supported versions: [4.3] + - name: RHEL 7 or OL 7 arch: x86_64 - supported versions: [4.0, 4.1, 4.2, 4.3] - - name: Ubuntu 18.04 + supported versions: [4.3] + - name: RHEL 8 or OL 8 arch: x86_64 - supported versions: [4.0, 4.1, 4.2, 4.3] + supported versions: [4.3] - name: Debian 10 arch: x86_64 - supported versions: [4.0, 4.1, 4.2, 4.3] + supported versions: [4.3] - name: Ubuntu 18.04 arch: x86_64 - supported versions: [4.0, 4.1, 4.2, 4.3] + supported versions: [4.3] - name: Ubuntu 20.04 arch: x86_64 - supported versions: [4.0, 4.1, 4.2, 4.3] + supported versions: [4.3] - name: SLES 12 arch: x86_64 supported versions: [4.3] @@ -612,16 +597,16 @@ products: platforms: - name: CentOS 7 arch: x86_64 - supported versions: [7, 8] + supported versions: [8] - name: AlmaLinux 8 or Rocky Linux 8 arch: x86_64 supported versions: [8] - name: RHEL 7 or OL 7 arch: x86_64 - supported versions: [7, 8] + supported versions: [8] - name: RHEL 8 or OL 8 arch: x86_64 - supported versions: [7, 8] + supported versions: [8] - name: RHEL 8 arch: ppc64le supported versions: [8] @@ -630,7 +615,7 @@ products: supported versions: [8] - name: Debian 9 arch: x86_64 - supported versions: [7, 8] + supported versions: [8] - name: Ubuntu 20.04 arch: x86_64 supported versions: [8] @@ -642,7 +627,7 @@ products: supported versions: [8] - name: SLES 12 arch: x86_64 - supported versions: [7, 8] + supported versions: [8] - name: SLES 15 arch: x86_64 supported versions: [8] @@ -669,7 +654,10 @@ products: - name: Ubuntu 18.04 arch: x86_64 supported versions: [7] - - name: Ubuntu 20.04 or Debian 10 + - name: Ubuntu 20.04 + arch: x86_64 + supported versions: [7] + - name: Debian 10 arch: x86_64 supported versions: [7] - name: SLES 12 diff --git a/install_template/templates/products/edb-jdbc-connector/centos-7_ppc64le.njk b/install_template/templates/products/edb-jdbc-connector/centos-7_ppc64le.njk deleted file mode 100644 index 3fcb93ad6f3..00000000000 --- a/install_template/templates/products/edb-jdbc-connector/centos-7_ppc64le.njk +++ /dev/null @@ -1,2 +0,0 @@ -{% extends "products/edb-jdbc-connector/centos-7.njk" %} -{% set includePPC = true %} diff --git a/install_template/templates/products/edb-jdbc-connector/rhel-7-or-ol-7_ppc64le.njk b/install_template/templates/products/edb-jdbc-connector/rhel-7-or-ol-7_ppc64le.njk deleted file mode 100644 index f5b18889610..00000000000 --- a/install_template/templates/products/edb-jdbc-connector/rhel-7-or-ol-7_ppc64le.njk +++ /dev/null @@ -1,2 +0,0 @@ -{% extends "products/edb-jdbc-connector/rhel-7-or-ol-7.njk" %} -{% set includePPC = true %} \ No newline at end of file diff --git a/install_template/templates/products/edb-jdbc-connector/rhel-8_ppc64le.njk b/install_template/templates/products/edb-jdbc-connector/rhel-8_ppc64le.njk new file mode 100644 index 00000000000..b53670b906e --- /dev/null +++ b/install_template/templates/products/edb-jdbc-connector/rhel-8_ppc64le.njk @@ -0,0 +1,2 @@ +{% extends "products/edb-jdbc-connector/rhel-8-or-ol-8.njk" %} +{% set includePPC = true %} \ No newline at end of file diff --git a/install_template/templates/products/edb-ocl-connector/centos-7_ppc64le.njk b/install_template/templates/products/edb-ocl-connector/centos-7_ppc64le.njk deleted file mode 100644 index 2c7baf131f6..00000000000 --- a/install_template/templates/products/edb-ocl-connector/centos-7_ppc64le.njk +++ /dev/null @@ -1,2 +0,0 @@ -{% extends "products/edb-ocl-connector/centos-7.njk" %} -{% set includePPC = true %} diff --git a/install_template/templates/products/edb-ocl-connector/rhel-7-or-ol-7_ppc64le.njk b/install_template/templates/products/edb-ocl-connector/rhel-7-or-ol-7_ppc64le.njk deleted file mode 100644 index f86f93620e3..00000000000 --- a/install_template/templates/products/edb-ocl-connector/rhel-7-or-ol-7_ppc64le.njk +++ /dev/null @@ -1,2 +0,0 @@ -{% extends "products/edb-ocl-connector/rhel-7-or-ol-7.njk" %} -{% set includePPC = true %} \ No newline at end of file diff --git a/install_template/templates/products/edb-ocl-connector/rhel-8_ppc64le.njk b/install_template/templates/products/edb-ocl-connector/rhel-8_ppc64le.njk new file mode 100644 index 00000000000..abcad167b00 --- /dev/null +++ b/install_template/templates/products/edb-ocl-connector/rhel-8_ppc64le.njk @@ -0,0 +1,2 @@ +{% extends "products/edb-ocl-connector/rhel-8-or-ol-8.njk" %} +{% set includePPC = true %} \ No newline at end of file diff --git a/install_template/templates/products/edb-odbc-connector/centos-7_ppc64le.njk b/install_template/templates/products/edb-odbc-connector/centos-7_ppc64le.njk deleted file mode 100644 index 81c735ec9f7..00000000000 --- a/install_template/templates/products/edb-odbc-connector/centos-7_ppc64le.njk +++ /dev/null @@ -1,2 +0,0 @@ -{% extends "products/edb-odbc-connector/centos-7.njk" %} -{% set includePPC = true %} diff --git a/install_template/templates/products/edb-odbc-connector/rhel-7-or-ol-7_ppc64le.njk b/install_template/templates/products/edb-odbc-connector/rhel-7-or-ol-7_ppc64le.njk deleted file mode 100644 index b3ee612762e..00000000000 --- a/install_template/templates/products/edb-odbc-connector/rhel-7-or-ol-7_ppc64le.njk +++ /dev/null @@ -1,2 +0,0 @@ -{% extends "products/edb-odbc-connector/rhel-7-or-ol-7.njk" %} -{% set includePPC = true %} \ No newline at end of file diff --git a/install_template/templates/products/edb-odbc-connector/rhel-8_ppc64le.njk b/install_template/templates/products/edb-odbc-connector/rhel-8_ppc64le.njk new file mode 100644 index 00000000000..1e7393370e0 --- /dev/null +++ b/install_template/templates/products/edb-odbc-connector/rhel-8_ppc64le.njk @@ -0,0 +1,2 @@ +{% extends "products/edb-odbc-connector/rhel-8-or-ol-8.njk" %} +{% set includePPC = true %} \ No newline at end of file diff --git a/install_template/templates/products/edb-pgbouncer/centos-7_ppc64le.njk b/install_template/templates/products/edb-pgbouncer/centos-7_ppc64le.njk deleted file mode 100644 index e6420f9bf37..00000000000 --- a/install_template/templates/products/edb-pgbouncer/centos-7_ppc64le.njk +++ /dev/null @@ -1,2 +0,0 @@ -{% extends "products/edb-pgbouncer/centos-7.njk" %} -{% set includePPC = true %} diff --git a/install_template/templates/products/edb-pgbouncer/rhel-7-or-ol-7_ppc64le.njk b/install_template/templates/products/edb-pgbouncer/rhel-7-or-ol-7_ppc64le.njk deleted file mode 100644 index 8764abd165c..00000000000 --- a/install_template/templates/products/edb-pgbouncer/rhel-7-or-ol-7_ppc64le.njk +++ /dev/null @@ -1,2 +0,0 @@ -{% extends "products/edb-pgbouncer/rhel-7-or-ol-7.njk" %} -{% set includePPC = true %} \ No newline at end of file diff --git a/install_template/templates/products/edb-pgbouncer/rhel-8_ppc64le.njk b/install_template/templates/products/edb-pgbouncer/rhel-8_ppc64le.njk new file mode 100644 index 00000000000..4c129698029 --- /dev/null +++ b/install_template/templates/products/edb-pgbouncer/rhel-8_ppc64le.njk @@ -0,0 +1,2 @@ +{% extends "products/edb-pgbouncer/rhel-8-or-ol-8.njk" %} +{% set includePPC = true %} \ No newline at end of file diff --git a/install_template/templates/products/edb-pgpool-ii-extensions/centos-7_ppc64le.njk b/install_template/templates/products/edb-pgpool-ii-extensions/centos-7_ppc64le.njk deleted file mode 100644 index ce9a0cf72d1..00000000000 --- a/install_template/templates/products/edb-pgpool-ii-extensions/centos-7_ppc64le.njk +++ /dev/null @@ -1,2 +0,0 @@ -{% extends "products/edb-pgpool-ii-extensions/centos-7.njk" %} -{% set includePPC = true %} diff --git a/install_template/templates/products/edb-pgpool-ii-extensions/rhel-7-or-ol-7_ppc64le.njk b/install_template/templates/products/edb-pgpool-ii-extensions/rhel-7-or-ol-7_ppc64le.njk deleted file mode 100644 index 1ddbea0fcd6..00000000000 --- a/install_template/templates/products/edb-pgpool-ii-extensions/rhel-7-or-ol-7_ppc64le.njk +++ /dev/null @@ -1,2 +0,0 @@ -{% extends "products/edb-pgpool-ii-extensions/rhel-7-or-ol-7.njk" %} -{% set includePPC = true %} \ No newline at end of file diff --git a/install_template/templates/products/edb-pgpool-ii-extensions/rhel-8_ppc64le.njk b/install_template/templates/products/edb-pgpool-ii-extensions/rhel-8_ppc64le.njk new file mode 100644 index 00000000000..6ced8de39ae --- /dev/null +++ b/install_template/templates/products/edb-pgpool-ii-extensions/rhel-8_ppc64le.njk @@ -0,0 +1,2 @@ +{% extends "products/edb-pgpool-ii-extensions/rhel-8-or-ol-8.njk" %} +{% set includePPC = true %} \ No newline at end of file diff --git a/install_template/templates/products/edb-pgpool-ii/centos-7_ppc64le.njk b/install_template/templates/products/edb-pgpool-ii/centos-7_ppc64le.njk deleted file mode 100644 index 81a8da6e3b0..00000000000 --- a/install_template/templates/products/edb-pgpool-ii/centos-7_ppc64le.njk +++ /dev/null @@ -1,2 +0,0 @@ -{% extends "products/edb-pgpool-ii/centos-7.njk" %} -{% set includePPC = true %} diff --git a/install_template/templates/products/edb-pgpool-ii/debian-9.njk b/install_template/templates/products/edb-pgpool-ii/debian-9.njk deleted file mode 100644 index b10e66ac90d..00000000000 --- a/install_template/templates/products/edb-pgpool-ii/debian-9.njk +++ /dev/null @@ -1,2 +0,0 @@ -{% extends "products/edb-pgpool-ii/debian.njk" %} -{% set platformBaseTemplate = "debian-9" %} \ No newline at end of file diff --git a/install_template/templates/products/edb-pgpool-ii/rhel-7-or-ol-7_ppc64le.njk b/install_template/templates/products/edb-pgpool-ii/rhel-7-or-ol-7_ppc64le.njk deleted file mode 100644 index 1e23d7a8481..00000000000 --- a/install_template/templates/products/edb-pgpool-ii/rhel-7-or-ol-7_ppc64le.njk +++ /dev/null @@ -1,2 +0,0 @@ -{% extends "products/edb-pgpool-ii/rhel-7-or-ol-7.njk" %} -{% set includePPC = true %} \ No newline at end of file diff --git a/install_template/templates/products/edb-pgpool-ii/rhel-8_ppc64le.njk b/install_template/templates/products/edb-pgpool-ii/rhel-8_ppc64le.njk new file mode 100644 index 00000000000..ec7192542f5 --- /dev/null +++ b/install_template/templates/products/edb-pgpool-ii/rhel-8_ppc64le.njk @@ -0,0 +1,2 @@ +{% extends "products/edb-pgpool-ii/rhel-8-or-ol-8.njk" %} +{% set includePPC = true %} \ No newline at end of file diff --git a/install_template/templates/products/migration-toolkit/centos-7_ppc64le.njk b/install_template/templates/products/migration-toolkit/centos-7_ppc64le.njk deleted file mode 100644 index 0a0b88d3ff2..00000000000 --- a/install_template/templates/products/migration-toolkit/centos-7_ppc64le.njk +++ /dev/null @@ -1,2 +0,0 @@ -{% extends "products/migration-toolkit/centos-7.njk" %} -{% set includePPC = true %} diff --git a/install_template/templates/products/migration-toolkit/rhel-7_ppc64le.njk b/install_template/templates/products/migration-toolkit/rhel-7_ppc64le.njk deleted file mode 100644 index e6f0f2d98ab..00000000000 --- a/install_template/templates/products/migration-toolkit/rhel-7_ppc64le.njk +++ /dev/null @@ -1,2 +0,0 @@ -{% extends "products/migration-toolkit/rhel-7-or-ol-7.njk" %} -{% set includePPC = true %} \ No newline at end of file diff --git a/install_template/templates/products/migration-toolkit/rhel-8_ppc64le.njk b/install_template/templates/products/migration-toolkit/rhel-8_ppc64le.njk new file mode 100644 index 00000000000..eae29beb0aa --- /dev/null +++ b/install_template/templates/products/migration-toolkit/rhel-8_ppc64le.njk @@ -0,0 +1,2 @@ +{% extends "products/migration-toolkit/rhel-8-or-ol-8.njk" %} +{% set includePPC = true %} \ No newline at end of file From ca4e5b9302967511884cc636ac5b4068f715606a Mon Sep 17 00:00:00 2001 From: John Long Date: Wed, 10 Aug 2022 10:43:57 -0400 Subject: [PATCH 08/16] Adding instructions for Openshift upgrade to 1.16.x --- .../1/rel_notes/1_16_rel_notes.mdx | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/product_docs/docs/postgres_for_kubernetes/1/rel_notes/1_16_rel_notes.mdx b/product_docs/docs/postgres_for_kubernetes/1/rel_notes/1_16_rel_notes.mdx index f72a4afbdd9..d7657ac62cc 100644 --- a/product_docs/docs/postgres_for_kubernetes/1/rel_notes/1_16_rel_notes.mdx +++ b/product_docs/docs/postgres_for_kubernetes/1/rel_notes/1_16_rel_notes.mdx @@ -23,5 +23,16 @@ As a result, we are introducing the following head versions in the new OLM chann Prior to this release, the only channel that we were supporting was the `stable` channel. This channel is now obsolete. However, for back compatibility it is currently set as an alias of the `stable-v1.15` channel and it will be removed once version 1.15 goes End of Life. +## Important information about upgrading from a 1.15.x operator version to a 1.16.x operator version on Openshift +We have made a change to the way Conditions are represented in the status of the operator in version 1.16.0 of our operator and onward. This change could cause an operator upgrade to hang on Openshift if one of the old conditions are set during the upgrade process because of the way the Operator Lifecycle Manager checks new CRD's against existing CR's. +Prior to installing 1.16.x on Openshift, if you are upgrading from a 1.15.x version of the operator, we recommend uninstalling the existing 1.15.x version of the operator then deleting all of the old conditions out of the statuses of all existing EDB Postgres for Kubernetes clusters. This will have no effect on the operability of your existing EDB Postgres for Kubernetes clusters. +To remove the existing conditions run: + +```bash +for CLUSTER in `oc get clusters -A -o custom-columns=:.metadata.name`; do kubectl patch --type='json' cluster $CLUSTER --subresource=status -p='[{"op": "remove", "path": "/status/conditions"}]'; done +``` + That command will remove all of the conditions from all of the EDB Postgres for Kubernetes clusters in your Openshift cluster. Upon the command completing you can safely install version 1.16.x. + + If you have already tried to upgrade to 1.16.x from 1.15.x and have the install of 1.16.x as "Pending" and 1.15.x as "Cannot update" you will need to uninstall both version of the operator and then run the command that removes the statuses. From 78dcce224bb97a0a3e9d950719333e159b7d6377 Mon Sep 17 00:00:00 2001 From: Gabriele Bartolini Date: Wed, 10 Aug 2022 17:50:47 +0200 Subject: [PATCH 09/16] doc: review Signed-off-by: Gabriele Bartolini --- .../1/rel_notes/1_16_rel_notes.mdx | 30 +++++++++++++++---- 1 file changed, 24 insertions(+), 6 deletions(-) diff --git a/product_docs/docs/postgres_for_kubernetes/1/rel_notes/1_16_rel_notes.mdx b/product_docs/docs/postgres_for_kubernetes/1/rel_notes/1_16_rel_notes.mdx index d7657ac62cc..1a35d736f28 100644 --- a/product_docs/docs/postgres_for_kubernetes/1/rel_notes/1_16_rel_notes.mdx +++ b/product_docs/docs/postgres_for_kubernetes/1/rel_notes/1_16_rel_notes.mdx @@ -23,16 +23,34 @@ As a result, we are introducing the following head versions in the new OLM chann Prior to this release, the only channel that we were supporting was the `stable` channel. This channel is now obsolete. However, for back compatibility it is currently set as an alias of the `stable-v1.15` channel and it will be removed once version 1.15 goes End of Life. -## Important information about upgrading from a 1.15.x operator version to a 1.16.x operator version on Openshift -We have made a change to the way Conditions are represented in the status of the operator in version 1.16.0 of our operator and onward. This change could cause an operator upgrade to hang on Openshift if one of the old conditions are set during the upgrade process because of the way the Operator Lifecycle Manager checks new CRD's against existing CR's. +## Important information about upgrading to a 1.16.x operator version on Openshift -Prior to installing 1.16.x on Openshift, if you are upgrading from a 1.15.x version of the operator, we recommend uninstalling the existing 1.15.x version of the operator then deleting all of the old conditions out of the statuses of all existing EDB Postgres for Kubernetes clusters. This will have no effect on the operability of your existing EDB Postgres for Kubernetes clusters. +We have made a change to the way Conditions are represented in the status of +the operator in version 1.16.0 and onward. This change could cause an operator +upgrade to hang on Openshift if one of the old conditions are set during the +upgrade process, because of the way the Operator Lifecycle Manager checks new +CRDs against existing CRs. + +Prior to installing 1.16.x on Openshift, if you are upgrading from a 1.15.x (or +earlier) version of the operator, we recommend uninstalling the existing +version of the operator, then deleting all of the old conditions out of the +statuses of all existing EDB Postgres for Kubernetes clusters. +This will have no effect on the operability of your existing EDB Postgres for +Kubernetes clusters. To remove the existing conditions run: ```bash -for CLUSTER in `oc get clusters -A -o custom-columns=:.metadata.name`; do kubectl patch --type='json' cluster $CLUSTER --subresource=status -p='[{"op": "remove", "path": "/status/conditions"}]'; done +for CLUSTER in `oc get clusters -A -o custom-columns=:.metadata.name`; do + kubectl patch --type='json' cluster $CLUSTER --subresource=status -p='[{"op": "remove", "path": "/status/conditions"}]' +done ``` - That command will remove all of the conditions from all of the EDB Postgres for Kubernetes clusters in your Openshift cluster. Upon the command completing you can safely install version 1.16.x. - If you have already tried to upgrade to 1.16.x from 1.15.x and have the install of 1.16.x as "Pending" and 1.15.x as "Cannot update" you will need to uninstall both version of the operator and then run the command that removes the statuses. +This command will remove all of the conditions from all of the EDB Postgres for +Kubernetes clusters in your Openshift cluster. +Upon the command completing you can safely install version 1.16.x. + +If you have already tried to upgrade to 1.16.x from 1.15.x (or earlier) and +have the install of 1.16.x marked as "Pending", while the previous one as +"Cannot update", you will need to uninstall both versions of the operator, and +then run the command that removes the statuses. From 8b3138505656b23d8e5e4d5f9f7fb994e0a0ae64 Mon Sep 17 00:00:00 2001 From: Dee Dee Rothery <83650384+drothery-edb@users.noreply.github.com> Date: Wed, 10 Aug 2022 12:22:30 -0400 Subject: [PATCH 10/16] copy edits --- .../1/rel_notes/1_16_rel_notes.mdx | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/product_docs/docs/postgres_for_kubernetes/1/rel_notes/1_16_rel_notes.mdx b/product_docs/docs/postgres_for_kubernetes/1/rel_notes/1_16_rel_notes.mdx index 1a35d736f28..917b4208bfd 100644 --- a/product_docs/docs/postgres_for_kubernetes/1/rel_notes/1_16_rel_notes.mdx +++ b/product_docs/docs/postgres_for_kubernetes/1/rel_notes/1_16_rel_notes.mdx @@ -21,14 +21,14 @@ As a result, we are introducing the following head versions in the new OLM chann * `stable-v1.16`: the latest available patch release of the 1.16 minor release * `stable-v1.15`: the latest available patch release of the 1.15 minor release -Prior to this release, the only channel that we were supporting was the `stable` channel. This channel is now obsolete. However, for back compatibility it is currently set as an alias of the `stable-v1.15` channel and it will be removed once version 1.15 goes End of Life. +Prior to this release, the only channel that we were supporting was the `stable` channel. This channel is now obsolete. However, for backward compatibility it is currently set as an alias of the `stable-v1.15` channel. It will be removed once version 1.15 reaches End of Life. ## Important information about upgrading to a 1.16.x operator version on Openshift -We have made a change to the way Conditions are represented in the status of +We have made a change to the way conditions are represented in the status of the operator in version 1.16.0 and onward. This change could cause an operator upgrade to hang on Openshift if one of the old conditions are set during the -upgrade process, because of the way the Operator Lifecycle Manager checks new +upgrade process because of the way the Operator Lifecycle Manager checks new CRDs against existing CRs. Prior to installing 1.16.x on Openshift, if you are upgrading from a 1.15.x (or @@ -46,11 +46,11 @@ for CLUSTER in `oc get clusters -A -o custom-columns=:.metadata.name`; do done ``` -This command will remove all of the conditions from all of the EDB Postgres for +This command removes all of the conditions from all of the EDB Postgres for Kubernetes clusters in your Openshift cluster. -Upon the command completing you can safely install version 1.16.x. +Once the command completes, you can safely install version 1.16.x. If you have already tried to upgrade to 1.16.x from 1.15.x (or earlier) and -have the install of 1.16.x marked as "Pending", while the previous one as -"Cannot update", you will need to uninstall both versions of the operator, and -then run the command that removes the statuses. +the install of 1.16.x shows as "Pending" and the earlier version shows as +"Cannot update", uninstall both versions of the operator and +run the command that removes the statuses. From 6c3b4811d6a827424bed6833bb8405fd5a1a4ffb Mon Sep 17 00:00:00 2001 From: Jonathan Gonzalez V Date: Wed, 10 Aug 2022 12:48:10 -0400 Subject: [PATCH 11/16] chore: review Signed-off-by: Jonathan Gonzalez V --- .../1/rel_notes/1_16_rel_notes.mdx | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/product_docs/docs/postgres_for_kubernetes/1/rel_notes/1_16_rel_notes.mdx b/product_docs/docs/postgres_for_kubernetes/1/rel_notes/1_16_rel_notes.mdx index 917b4208bfd..705f1237aa1 100644 --- a/product_docs/docs/postgres_for_kubernetes/1/rel_notes/1_16_rel_notes.mdx +++ b/product_docs/docs/postgres_for_kubernetes/1/rel_notes/1_16_rel_notes.mdx @@ -17,7 +17,7 @@ We are adopting a new policy to support the last two minor versions of the produ As a result, we are introducing the following head versions in the new OLM channels in OpenShift to manage the update streams for EDB Postgres for Kubernetes: -* `fast`: the latest available patch release for the latest available minor release +* `fast`: the latest available patch release for the latest available minor release * `stable-v1.16`: the latest available patch release of the 1.16 minor release * `stable-v1.15`: the latest available patch release of the 1.15 minor release @@ -41,12 +41,17 @@ Kubernetes clusters. To remove the existing conditions run: ```bash -for CLUSTER in `oc get clusters -A -o custom-columns=:.metadata.name`; do - kubectl patch --type='json' cluster $CLUSTER --subresource=status -p='[{"op": "remove", "path": "/status/conditions"}]' -done +while IFS=' ' read NS CLUSTER; do + kubectl -n ${NS} patch --type='json' ${CLUSTER} --subresource=status -p='[{"op": "remove", "path": "/status/conditions"}]'; +done < <(kubectl get cluster -A --no-headers=true -o jsonpath='{range .items[*]}{.metadata.namespace}{" cluster/"}{.metadata.name}{"\n"}{end}') ``` -This command removes all of the conditions from all of the EDB Postgres for +!!! Important + The kubectl command must be version 1.24 or higher. + If you get the output `The request is invalid` it means that the traget cluster + didn't have any condition on it. + +This command will remove all of the conditions from all of the EDB Postgres for Kubernetes clusters in your Openshift cluster. Once the command completes, you can safely install version 1.16.x. From 34b3e920b8ee9e7fc5f086690d1653408e4c650d Mon Sep 17 00:00:00 2001 From: Josh Heyer Date: Wed, 10 Aug 2022 00:13:25 +0000 Subject: [PATCH 12/16] Cleanly separate commands and output in BA shell listings Fixes #3022 --- .../01_preparing_azure/index.mdx | 5 +- .../docs/biganimal/release/reference/api.mdx | 36 ++++---- .../docs/biganimal/release/reference/cli.mdx | 89 ++++++++++++++----- .../01_private_endpoint.mdx | 32 ++++--- .../02_virtual_network_peering.mdx | 9 +- .../01_connecting_from_azure/03_vnet_vnet.mdx | 35 ++++++-- .../01_vpc_endpoint.mdx | 3 +- .../02_connecting_from_aws/02_vpc_peering.mdx | 34 +++---- 8 files changed, 158 insertions(+), 85 deletions(-) diff --git a/product_docs/docs/biganimal/release/getting_started/preparing_cloud_account/01_preparing_azure/index.mdx b/product_docs/docs/biganimal/release/getting_started/preparing_cloud_account/01_preparing_azure/index.mdx index 412e7ea2cd9..6e6b39a9072 100644 --- a/product_docs/docs/biganimal/release/getting_started/preparing_cloud_account/01_preparing_azure/index.mdx +++ b/product_docs/docs/biganimal/release/getting_started/preparing_cloud_account/01_preparing_azure/index.mdx @@ -126,7 +126,7 @@ To check if an Azure resource provider is registered, use the following command. ```shell az provider show -n Microsoft.ContainerService - +__OUTPUT__ Namespace RegistrationPolicy RegistrationState -------------------------- -------------------- ------------------- Microsoft.ContainerService RegistrationRequired Registered @@ -139,7 +139,7 @@ You can check SKU restrictions for the VM size using the Azure Cloud Shell. For ```shell az vm list-skus -l eastus2 --zone --size Standard_E2s_v3 - +__OUTPUT__ ResourceType Locations Name Zones Restrictions --------------- ----------- --------------- ------- ------------ virtualMachines eastus2 Standard_E2s_v3 1,2,3 NotAvailableForSubscription, type: Zone, locations: eastus2, zones: 3,2 @@ -179,6 +179,7 @@ use the [register command](https://docs.microsoft.com/en-us/cli/azure/provider?v ```shell az provider register -n Microsoft.ContainerService +__OUTPUT__ Registering is still on-going. You can monitor using 'az provider show -n Microsoft.ContainerService ``` diff --git a/product_docs/docs/biganimal/release/reference/api.mdx b/product_docs/docs/biganimal/release/reference/api.mdx index 4aed4ba8eeb..381b961a96d 100644 --- a/product_docs/docs/biganimal/release/reference/api.mdx +++ b/product_docs/docs/biganimal/release/reference/api.mdx @@ -27,13 +27,13 @@ This call returns the information that either: - You need later if you're using `curl` to request the device code and tokens. - The `get-token` script uses to generate the tokens for you. -``` +```shell curl https://portal.biganimal.com/api/v2/auth/provider ``` The response returns the `clientId`, `freetrialClientId`, `issuerUri`, `scope`, and `audience`. For example: -``` +```json { "clientId": "5B79FAjzKF2Ig5dVFAOhc1acDSJYY2xh", "freetrialClientId": "m71bEVZrGsWiKtPqMI3hYCHCG3EYLPDk", @@ -66,7 +66,7 @@ The following example calls use these environment variables. This call gets a device code: -``` +```shell curl --request POST \ --url "$ISSUER_URL/oauth/device/code" \ --header "content-type: application/x-www-form-urlencoded" \ @@ -86,7 +86,7 @@ The response returns: For example: -``` +```json { "device_code": "KEOY2_5YjuVsRuIrrR-aq5gs", "user_code": "HHHJ-MMSZ", @@ -120,7 +120,7 @@ DEVICE_CODE=KEOY2_5YjuVsRuIrrR-aq5gs The `curl --request POST` call requests a token. For example: -``` +```shell curl --request POST \ --url "$ISSUER_URL/oauth/token" \ --header "content-type: application/x-www-form-urlencoded" \ @@ -139,7 +139,7 @@ If successful, the call returns: For example: -``` +```json { "access_token": "eyJhbGc.......1Qtkaw2fyho", "id_token": "eyJhbGci.......FBra7tA", @@ -152,7 +152,7 @@ For example: Store the access token and refresh token in environment variables for future use. For example: -``` +```ini RAW_ACCESS_TOKEN="eyJhbGc.......1Qtkaw2fyho" REFRESH_TOKEN="v2.MTvuZpu.......sbiionEhtTw" ``` @@ -179,7 +179,7 @@ If not successful, you receive one of the following errors: Use the raw token you obtained in the previous step [Request the raw token using `curl`](#request-the-raw-token-using-curl) to get the BigAnimal token: -``` +```shell curl -s --request POST \ --url "https://portal.biganimal.com/api/v2/auth/token" \ --header "content-type: application/json" \ @@ -192,7 +192,7 @@ If successful, the call returns: For example: -``` +```json { "token": "eyJhbGc.......0HFkr_19Vr7w" } @@ -201,7 +201,7 @@ For example: This token, as opposed to the raw-access token, is recognized by the BigAnimal API. Store this token in environment variables for future use. For example: -``` +```ini ACCESS_TOKEN="eyJhbGc.......0HFkr_19Vr7w" ``` @@ -213,7 +213,7 @@ Contact [Customer Support](../overview/support) if you have trouble obtaining a To call the BigAnimal API, your application must pass the retrieved access token as a bearer token in the Authorization header of your HTTP request. For example: -``` +```shell curl --request GET \ --url "$AUDIENCE/v2/postgres-types" \ --header "authorization: Bearer $ACCESS_TOKEN" \ @@ -222,7 +222,7 @@ curl --request GET \ Example response: -``` +```json { "pgTypesList": [ { @@ -253,7 +253,7 @@ The `get-token` script has an option to execute this step. See [Refresh the toke If you aren't using the `get-token` script to refresh your token, make a POST request to the `/oauth/token` endpoint in the Authentication API, using `grant_type=refresh_token`. For example: -``` +```shell curl --request POST \ --url "$ISSUER_URL/oauth/token" \ --header "content-type: application/x-www-form-urlencoded" \ @@ -268,7 +268,7 @@ The `client_id` is always the same one in the response when you [queried the aut The response of this API call includes the `access_token`. For example: -``` +```json { "access_token": "eyJ...MoQ", "expires_in": 86400, @@ -281,7 +281,7 @@ The response of this API call includes the `access_token`. For example: Store the access token and refresh token in environment variables for future use. For example: -``` +```ini RAW_ACCESS_TOKEN="eyJhbGc.......1Qtkaw2fyho" REFRESH_TOKEN="v2.MTvuZpu.......sbiionEhtTw" ``` @@ -322,8 +322,9 @@ Reference: https://www.enterprisedb.com/docs/biganimal/latest/reference/api/ To use the `get-token` script to get your tokens, use the script without the `--refresh` option. For example: -``` +```shell ./get-token.sh -o plain +__OUTPUT__ Please login to https://biganimal.us.auth0.com/activate?user_code=ZMNX-VVJT with your BigAnimal account @@ -343,8 +344,9 @@ xxxxxxxxxx To use the `get-token` script to refresh your token, use the script with the `--refresh ` option. For example: -``` +```shell ./get-token.sh -o json --refresh v2.MVZ9_xxxxxxxx_FRs +__OUTPUT__ { "access_token": "xxxxxxxxxx", "refresh_token": "xxxxxxxxxxxx", diff --git a/product_docs/docs/biganimal/release/reference/cli.mdx b/product_docs/docs/biganimal/release/reference/cli.mdx index 0d3e14456f5..9b580869a08 100644 --- a/product_docs/docs/biganimal/release/reference/cli.mdx +++ b/product_docs/docs/biganimal/release/reference/cli.mdx @@ -45,7 +45,11 @@ The CLI is available for Linux, MacOS, and Windows operating systems. Before using the CLI to manage BigAnimal, you need to authenticate as a valid BigAnimal user. Use the `create-credential` command to authenticate through the BigAnimal website and assign a refresh token and an access token to a local credential. For example: ```shell -$ biganimal create-credential --name ba-user1 --address portal.biganimal.com --port 443 +biganimal create-credential \ + --name ba-user1 \ + --address portal.biganimal.com \ + --port 443 +__OUTPUT__ Querying Authentication Endpoint for 'portal.biganimal.com First, copy your one-time code: CWWG-SMXC @@ -58,7 +62,8 @@ Credential "ba-user1" created! Refresh tokens expire after 30 days. To continue using the credential to access the CLI, use the `reset-credential` command to authenticate through the BigAnimal website and receive a new refresh token. ```shell -$ biganimal reset-credential ba-user1 +biganimal reset-credential ba-user1 +__OUTPUT__ Visit this URL to login: https://auth.biganimal.com/activate?user_code=****-**** or press [Enter] to continue in the web browser @@ -68,8 +73,9 @@ Credential "ba-user1" reset operation succeeded You can create multiple credentials for different BigAnimal accounts and then set one as context of your current management session. Use `show-credentials` to list all available credentials and use `config set context_credential` to set a default credential for the current context. For example: -``` -$ biganimal show-credentials +```shell +biganimal show-credentials +__OUTPUT__ ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ ┃ Credentials ┃ ┣━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━┫ @@ -79,7 +85,10 @@ $ biganimal show-credentials ┃ ba-user2 ┃ portal.biganimal.com ┃ 443 ┃ ┃ ┗━━━━━━━━━━┻━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┻━━━━━━┻━━━━━━━━━━━━━━━━━━━━━━━━━┛ The credential ba-user1 has been set up -$ biganimal config set context_credential ba-user1 +``` + +```shell +biganimal config set context_credential ba-user1 ``` !!! Note @@ -91,7 +100,7 @@ The initial running of the CLI creates a hidden configuration folder in your use Don’t edit files in this directory directly. Instead, use the `config` subcommand to list and update the configuration settings of the CLI. Use the following command to get detailed usage and available configurations inforamtion: ```shell -$ biganimal config +biganimal config ``` ### Available configuration settings @@ -114,14 +123,14 @@ Use the `-h` or `--help` flags for more information on the CLI commands. You can You can enable command line auto completion for bash, fish, powershell, and zsh. To set up auto completion: ```shell -$ biganimal completion +biganimal completion ``` ### Interactive mode In interactive mode, the CLI prompts you for any missing mandatory flags and lists any available options for your current context. To enable interactive mode: ```shell -$ biganimal config set interactive_mode on +biganimal config set interactive_mode on ``` ## Sample use cases @@ -136,7 +145,8 @@ You can turn off prompting using the `biganimal config set interactive_mode off` !!! ```shell -$ biganimal create-cluster +biganimal create-cluster +__OUTPUT__ Cluster architecture: High Availability Number of standby replicas: 2 Replicas Provider: Azure @@ -166,8 +176,9 @@ Volume properties? You are prompted to confirm you want to create the cluster. After the cluster creation process is completed, it generates a cluster ID. -``` -$ biganimal create-cluster +```shell +biganimal create-cluster +__OUTPUT__ ........ Are you sure you want to Create Cluster ? [y|n]: y Create Cluster operation is started @@ -177,8 +188,9 @@ To check current state, run: biganimal show-clusters --id p-gxhkfww1fe Check your cluster was created successfully using the `show-clusters` command shown in the return message: -``` -$ biganimal show-clusters --id p-gxhkfww1fe +```shell +biganimal show-clusters --id p-gxhkfww1fe +__OUTPUT__ ┌─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ │ Clusters │ ├──────────────┬──────────────────────┬────────────────────┬──────────┬──────────────┬──────────────┬──────────────────────────────┬─────────┤ @@ -223,7 +235,7 @@ Here is a sample configuration file in YAML format with Azure specified as the p !!! Note For backward compatibility, `allowIpRangeMap` and `pgConfigMap` properties also support embedded JSON format. - ``` + ```json allowIpRangeMap: [["9.9.9.9/28", "Allow traffic from App A"],["10.10.10.10/27", "Allow traffic from App B"]] pgConfigMap: [["application_name","test_app"],["array_nulls","true"]] ``` @@ -239,6 +251,7 @@ To query an enumeration of valid values for above BigAnimal and cloud service pr ```shell biganimal show-cluster-architecture +__OUTPUT__ ┌──────────────────────────────────────────────┐ │ Architecture │ ├────────┬───────────────────────────┬─────────┤ @@ -263,8 +276,12 @@ You can turn off the confirmation step with the `biganimal disable-confirm` comm To use your BigAnimal cluster, you first need to get your cluster's connection information. To get your cluster's connection information, use the `show-cluster-connection` command: -``` -$ biganimal show-cluster-connection --name my-biganimal-cluster --provider azure --region eastus +```shell +biganimal show-cluster-connection \ + --name my-biganimal-cluster \ + --provider azure \ + --region eastus +__OUTPUT__ ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ ┃ Connection String ┃ ┣━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┫ @@ -276,7 +293,11 @@ $ biganimal show-cluster-connection --name my-biganimal-cluster --provider azure You can query the complete connection information with other output formats, like JSON or YAML. For example: ```shell -biganimal show-cluster-connection --name my-biganimal-cluster --provider azure --region eastus --ouput json +biganimal show-cluster-connection \ + --name my-biganimal-cluster \ + --provider azure \ + --region eastus \ + --ouput json ``` !!! @@ -296,13 +317,19 @@ After the cluster is created, you can update attributes of the cluster including For example, to set the public allowed IP range list, use the `--cidr-blocks` flag: ```shell -$ biganimal update-cluster --name my-biganimal-cluster --provider azure --region eastus --cidr-blocks --cidr-blocks "9.9.9.9/28=Traffic from App A" +biganimal update-cluster --name my-biganimal-cluster --provider azure \ + --region eastus \ + --cidr-blocks "9.9.9.9/28=Traffic from App A" ``` To check whether the setting took effect, use the `show-clusters` command and view the detailed cluster information output in JSON format. For example, ```shell -$ biganimal show-clusters --name my-biganimal-cluster --provider azure --region eastus --output json | jq '.[0].allowIpRangeMap' +biganimal show-clusters --name my-biganimal-cluster --provider azure \ + --region eastus \ + --output json \ +| jq '.[0].allowIpRangeMap' +__OUTPUT__ [ [ "9.9.9.9/28", @@ -316,7 +343,9 @@ $ biganimal show-clusters --name my-biganimal-cluster --provider azure --region To update the Postgres configuration of a BigAnimal cluster directly from the CLI: ```shell -biganimal update-cluster --id p-gxhkfww1fe --pg-config "application_name=ba_test_app,array_nulls=false" +biganimal update-cluster --id p-gxhkfww1fe \ + --pg-config "application_name=ba_test_app,array_nulls=false" +__OUTPUT__ Update Cluster operation is started Cluster ID is "p-gxhkfww1fe" ``` @@ -331,7 +360,20 @@ You can update "Cluster Architecture" with the `--cluster-architecture` flag. Th Biganimal continuously backs up your PostgrSQL clusters. Using CLI you can restore a cluster from its backup to any point in time as long as the backups are retained in the backup storage. The restored cluster can be a in another region and with different configurations, you can specify new configurations in restore command. For example: ```shell -biganimal restore-cluster --name "my-biganimal-cluster" --provider "azure" --region "eastus" --password "mypassword@123" --new-name "my-biganimal-cluster-restored" --new-region="eastus2" --cluster-architecture "single" --instance-type "azure:Standard_E2s_v3" --volume-type "azurepremiumstorage" --volume-property "P1" --networking "public" --cidr-blocks="10.10.10.10/27=Traffic from App B" --restore-point "2022-01-26T15:04:05+0800" +biganimal restore-cluster \ + --name "my-biganimal-cluster" \ + --provider "azure" \ + --region "eastus" \ + --password "mypassword@123" \ + --new-name "my-biganimal-cluster-restored" \ + --new-region="eastus2" \ + --cluster-architecture "single" \ + --instance-type "azure:Standard_E2s_v3" \ + --volume-type "azurepremiumstorage" \ + --volume-property "P1" \ + --networking "public" \ + --cidr-blocks="10.10.10.10/27=Traffic from App B" \ + --restore-point "2022-01-26T15:04:05+0800" ``` The password for the restored cluster is a mandatory. The other parameters, if not specified, inherit the source database's settings. In interactive mode, the source database's settings appear as the default input, or appear as the first option in a selection list. @@ -347,7 +389,10 @@ You can restore a cluster in a "Single" cluster to a "High Availability" cluster To delete a cluster you no longer need, use the `delete-cluster` command. For example: ```shell -$ biganimal delete-cluster --name my-biganimal-cluster --provider azure --region eastus +biganimal delete-cluster \ + --name my-biganimal-cluster \ + --provider azure \ + --region eastus ``` You can list all deleted clusters with the `show-deleted-clusters` command and restore them from their history backups as needed. diff --git a/product_docs/docs/biganimal/release/using_cluster/02_connecting_your_cluster/01_connecting_from_azure/01_private_endpoint.mdx b/product_docs/docs/biganimal/release/using_cluster/02_connecting_your_cluster/01_connecting_from_azure/01_private_endpoint.mdx index 857894ba118..f0b6884301c 100644 --- a/product_docs/docs/biganimal/release/using_cluster/02_connecting_your_cluster/01_connecting_from_azure/01_private_endpoint.mdx +++ b/product_docs/docs/biganimal/release/using_cluster/02_connecting_your_cluster/01_connecting_from_azure/01_private_endpoint.mdx @@ -30,7 +30,8 @@ To walk through an example in your own environment, you need: - The IP address of your cluster. You can find the IP address of your cluster using the following command: ```shell - $ dig +short p-c4j0jfcmp3af2ieok5eg.brcxzr08qr7rbei1.biganimal.io + dig +short p-c4j0jfcmp3af2ieok5eg.brcxzr08qr7rbei1.biganimal.io + __OUTPUT__ 10.240.1.218 ``` - A Postgresql client, such as [psql](https://www.postgresql.org/download/), installed on your client VM. @@ -42,7 +43,7 @@ To walk through an example in your own environment, you need: 1. Get the resource group details from the Azure CLI or the Azure portal and note the resource group name. For example, if the cluster's virtual network is `vnet-japaneast`, use the following command: ```shell - $ az network vnet list --query "[?name==\`vnet-japaneast\`].resourceGroup" -o json + az network vnet list --query "[?name==\`vnet-japaneast\`].resourceGroup" -o json ``` @@ -67,7 +68,8 @@ To walk through an example in your own environment, you need: You can get the IP address of your cluster with the following command: ```shell - $ dig +short p-c4j0jfcmp3af2ieok5eg.brcxzr08qr7rbei1.biganimal.io + dig +short p-c4j0jfcmp3af2ieok5eg.brcxzr08qr7rbei1.biganimal.io + __OUTPUT__ 10.240.1.218 ``` @@ -84,8 +86,9 @@ To walk through an example in your own environment, you need: 5. After the private link service is created, note its alias. The alias is the unique ID for your private service, which you can share with the service consumers. Obtain the alias either from the Azure portal or by using the following CLI command: ```shell - $ az network private-link-service list --query "[?name=='p-c4j0jfcmp3af2ieok5eg-service-private-link'].alias" -o tsv - p-c4j0jfcmp3af2ieok5eg-service-private-link.48f26b42-45dc-4e80-8e3d-307d58d7d274.japaneast.azure.privatelinkservice + az network private-link-service list --query "[?name=='p-c4j0jfcmp3af2ieok5eg-service-private-link'].alias" -o tsv + __OUTPUT__ + p-c4j0jfcmp3af2ieok5eg-service-private-link.48f26b42-45dc-4e80-8e3d-307d58d7d274.japaneast.azure.privatelinkservice ``` 6. Select **Review + Create**. @@ -135,16 +138,17 @@ To walk through an example in your own environment, you need: 11. You have successfully built a tunnel between your client VM's virtual network and the cluster. You can now access the cluster from the private endpoint in your client VM. The private endpoint's private IP address is associated with an independent virtual network NIC. Get the private endpoint's private IP address using the following commands: ```shell - $ NICID=$(az network private-endpoint show -n vnet-client-private-pg-service -g rg-client --query "networkInterfaces[0].id" -o tsv) - $ az network nic show -n ${NICID##*/} -g rg-client --query "ipConfigurations[0].privateIpAddress" -o tsv - 100.64.111.5 + NICID=$(az network private-endpoint show -n vnet-client-private-pg-service -g rg-client --query "networkInterfaces[0].id" -o tsv) + az network nic show -n ${NICID##*/} -g rg-client --query "ipConfigurations[0].privateIpAddress" -o tsv + __OUTPUT__ + 100.64.111.5 ``` 12. From the client VM `vm-client`, access the cluster by using the private IP address: ```shell - $ psql -h 100.64.111.5 -U edb_admin - + psql -h 100.64.111.5 -U edb_admin + __OUTPUT__ Password for user edb_admin : psql (13.4 (Ubuntu 13.4-1.pgdg20.04+1), server 13.4.8 (Debian 13.4.8-1+deb10)) @@ -186,10 +190,10 @@ With a Private DNS Zone, you configure a DNS entry for your cluster's public hos 7. You can now access your cluster with this private domain name. ```shell - $ dig +short p-c4iabjleig40jngmac40.brcxzr08qr7rbei1.biganimal.io + dig +short p-c4iabjleig40jngmac40.brcxzr08qr7rbei1.biganimal.io + psql -h p-c4iabjleig40jngmac40.brcxzr08qr7rbei1.biganimal.io -U edb_admin + __OUTPUT__ 10.240.1.123 - - $ psql -h p-c4iabjleig40jngmac40.brcxzr08qr7rbei1.biganimal.io -U edb_admin Password for user edb_admin: psql (13.4 (Ubuntu 13.4-1.pgdg28.84+1), server 13.4.8 (Debian 13.4.8-1+deb10)) @@ -204,5 +208,5 @@ With a Private DNS Zone, you configure a DNS entry for your cluster's public hos You might need to flush your local DNS cache to resolve your domain name to the new private IP address after adding the private endpoint. For example, on Ubuntu, run the following command: ```shell - $ sudo systemd-resolve --flush-caches + sudo systemd-resolve --flush-caches ``` diff --git a/product_docs/docs/biganimal/release/using_cluster/02_connecting_your_cluster/01_connecting_from_azure/02_virtual_network_peering.mdx b/product_docs/docs/biganimal/release/using_cluster/02_connecting_your_cluster/01_connecting_from_azure/02_virtual_network_peering.mdx index 44c82b1c981..01917c863fa 100644 --- a/product_docs/docs/biganimal/release/using_cluster/02_connecting_your_cluster/01_connecting_from_azure/02_virtual_network_peering.mdx +++ b/product_docs/docs/biganimal/release/using_cluster/02_connecting_your_cluster/01_connecting_from_azure/02_virtual_network_peering.mdx @@ -32,7 +32,8 @@ To walk through an example in your own environment, you need: - The IP address of your cluster. You can find the IP address of your cluster using the following command: ```shell - $ dig +short p-c4j0jfcmp3af2ieok5eg.brcxzr08qr7rbei1.biganimal.io + dig +short p-c4j0jfcmp3af2ieok5eg.brcxzr08qr7rbei1.biganimal.io + __OUTPUT__ 10.240.1.218 ``` - A Postgresql client, such as [psql](https://www.postgresql.org/download/), installed on your client VM. @@ -63,10 +64,10 @@ You need to add two peering links, one from the client VM's VNet `vnet-client` a Access the cluster with its domain name from your cluster's connection string. It's accessible from `vnet-client` after peering. ```shell -$ dig +short p-c4j0jfcmp3af2ieok5eg.brcxzr08qr7rbei1.biganimal.io +dig +short p-c4j0jfcmp3af2ieok5eg.brcxzr08qr7rbei1.biganimal.io +psql -h p-c4j0jfcmp3af2ieok5eg.brcxzr08qr7rbei1.biganimal.io -U edb_admin +__OUTPUT__ 10.240.1.123 - -$ psql -h p-c4j0jfcmp3af2ieok5eg.brcxzr08qr7rbei1.biganimal.io -U edb_admin Password for user edb_admin: psql (13.4 (Ubuntu 13.4-1.pgdg28.84+1), server 13.4.8 (Debian 13.4.8-1+deb10)) diff --git a/product_docs/docs/biganimal/release/using_cluster/02_connecting_your_cluster/01_connecting_from_azure/03_vnet_vnet.mdx b/product_docs/docs/biganimal/release/using_cluster/02_connecting_your_cluster/01_connecting_from_azure/03_vnet_vnet.mdx index 72724598765..557d1bfdf3d 100644 --- a/product_docs/docs/biganimal/release/using_cluster/02_connecting_your_cluster/01_connecting_from_azure/03_vnet_vnet.mdx +++ b/product_docs/docs/biganimal/release/using_cluster/02_connecting_your_cluster/01_connecting_from_azure/03_vnet_vnet.mdx @@ -34,7 +34,8 @@ To walk through an example in your own environment, you need: - The IP address of your cluster. You can find the IP address of your cluster using the following command: ```shell - $ dig +short p-c4j0jfcmp3af2ieok5eg.brcxzr08qr7rbei1.biganimal.io + dig +short p-c4j0jfcmp3af2ieok5eg.brcxzr08qr7rbei1.biganimal.io + __OUTPUT__ 10.240.1.218 ``` - A Postgresql client, such as [psql](https://www.postgresql.org/download/), installed on your client VM. @@ -68,21 +69,29 @@ Use the Azure CLI (or [PowerShell](https://docs.microsoft.com/en-us/azure/vpn-ga **From the BigAnimal subscription**: ```shell - $ az network vnet-gateway show -n vpng-biganimal -g brCxzr08qr7RBEi1-rg-japaneast-management --query "[id]" -otsv + az network vnet-gateway show -n vpng-biganimal -g brCxzr08qr7RBEi1-rg-japaneast-management --query "[id]" -otsv + __OUTPUT__ subscriptions/.../vpng-biganimal ``` **From the client VM's subscription**: ```shell - $ az network vnet-gateway show -n vpng-client -g rg-client --query "[id]" -o tsv + az network vnet-gateway show -n vpng-client -g rg-client --query "[id]" -o tsv + __OUTPUT__ /subscriptions/.../vpng-client ``` 2. From the BigAnimal subscription, create a connection from `vpng-biganimal` to `vpng-client`. ```shell - $ az network vpn-connection create -n vpnc-biganimal-client -g brCxzr08qr7RBEi1-rg-japaneast-management --vnet-gateway1 /subscriptions/.../vpng-biganimal -l japaneast --shared-key "a_very_long_and_complex_psk" \--vnet-gateway2 /subscriptions/.../vpng-client + az network vpn-connection create \ + -n vpnc-biganimal-client \ + -g brCxzr08qr7RBEi1-rg-japaneast-management \ + --vnet-gateway1 /subscriptions/.../vpng-biganimal \ + -l japaneast + --shared-key "a_very_long_and_complex_psk" \ + --vnet-gateway2 /subscriptions/.../vpng-client ``` @@ -91,7 +100,13 @@ Use the Azure CLI (or [PowerShell](https://docs.microsoft.com/en-us/azure/vpn-ga 3. From the client VM's subscription, create another connection from `vpng-client` to `vpng-ebdcloud`. ```shell - $ az network vpn-connection create -n vpnc-client-biganimal -g rg-client --vnet-gateway1 /subscriptions/.../vpng-client -l japaneast --shared-key "a_very_long_and_complex_psk!" --vnet-gateway2 /subscriptions/.../vpng-biganimal + az network vpn-connection create \ + -n vpnc-client-biganimal \ + -g rg-client \ + --vnet-gateway1 /subscriptions/.../vpng-client \ + -l japaneast \ + --shared-key "a_very_long_and_complex_psk!" \ + --vnet-gateway2 /subscriptions/.../vpng-biganimal ``` #### Step 4: Verify the connection @@ -99,17 +114,19 @@ Use the Azure CLI (or [PowerShell](https://docs.microsoft.com/en-us/azure/vpn-ga 1. After a few minutes, verify the gateway connection status from either virtual networks with the following command: ```shell - $ az network vpn-connection show --name vpnc-client-biganimal -g rg-client --query "[connectionStatus]" -o tsv + az network vpn-connection show --name vpnc-client-biganimal -g rg-client \ + --query "[connectionStatus]" -o tsv + __OUTPUT__ Connected ``` 2. Verify the connectivity to the cluster: ```shell - $ dig +short p-c4j0jfcmp3af2ieok5eg.brcxzr08qr7rbei1.biganimal.io + dig +short p-c4j0jfcmp3af2ieok5eg.brcxzr08qr7rbei1.biganimal.io + psql -h p-c4j0jfcmp3af2ieok5eg.brcxzr08qr7rbei1.biganimal.io -U edb_admin + __OUTPUT__ 10.240.1.123 - - $ psql -h p-c4j0jfcmp3af2ieok5eg.brcxzr08qr7rbei1.biganimal.io -U edb_admin Password for user edb_admin: psql (13.4 (Ubuntu 13.4-1.pgdg28.84+1), server 13.4.8 (Debian 13.4.8-1+deb10)) diff --git a/product_docs/docs/biganimal/release/using_cluster/02_connecting_your_cluster/02_connecting_from_aws/01_vpc_endpoint.mdx b/product_docs/docs/biganimal/release/using_cluster/02_connecting_your_cluster/02_connecting_from_aws/01_vpc_endpoint.mdx index 59349a30df4..46470b89dbf 100644 --- a/product_docs/docs/biganimal/release/using_cluster/02_connecting_your_cluster/02_connecting_from_aws/01_vpc_endpoint.mdx +++ b/product_docs/docs/biganimal/release/using_cluster/02_connecting_your_cluster/02_connecting_from_aws/01_vpc_endpoint.mdx @@ -99,7 +99,8 @@ Now that your endpoint service is created, you can connect it to the cluster VPC In your application's AWS account, select **VPC** and then select **Endpoints**. Select the endpoint you created previously and use the DNS name provided in the details section to access your cluster. ```shell - $ psql -h vpce-XXXXXXXXXXXXXXXXXXXX.eu-west-1.vpce.amazonaws.com -U edb_admin + psql -h vpce-XXXXXXXXXXXXXXXXXXXX.eu-west-1.vpce.amazonaws.com -U edb_admin + __OUTPUT__ Password for user edb_admin: psql (13.4 (Ubuntu 13.4-1.pgdg28.84+1), server 13.4.8 (Debian 13.4.8-1+deb10)) diff --git a/product_docs/docs/biganimal/release/using_cluster/02_connecting_your_cluster/02_connecting_from_aws/02_vpc_peering.mdx b/product_docs/docs/biganimal/release/using_cluster/02_connecting_your_cluster/02_connecting_from_aws/02_vpc_peering.mdx index bef71dcec38..79ab68a8311 100644 --- a/product_docs/docs/biganimal/release/using_cluster/02_connecting_your_cluster/02_connecting_from_aws/02_vpc_peering.mdx +++ b/product_docs/docs/biganimal/release/using_cluster/02_connecting_your_cluster/02_connecting_from_aws/02_vpc_peering.mdx @@ -91,16 +91,17 @@ You can create a VPC peering connection with a VPC in the same region or a diffe 1. Access the cluster with its domain name from your cluster's connection string. It's accessible from `vpc-client` after peering. -```shell - $ psql -h vpce-XXXXXXXXXXXXXXXXXXXX.eu-west-1.vpce.amazonaws.com -U edb_admin - Password for user edb_admin: + ```shell + psql -h vpce-XXXXXXXXXXXXXXXXXXXX.eu-west-1.vpce.amazonaws.com -U edb_admin + __OUTPUT__ + Password for user edb_admin: - psql (13.4 (Ubuntu 13.4-1.pgdg28.84+1), server 13.4.8 (Debian 13.4.8-1+deb10)) - WARNING : psql major version 13, server major version 13. Some psql features might not work. - SSL connection (protocol : TLSV1.3cipherTLS_AES_256_GCM_SHA384, bits : 256, compression : off) Type "help" for help. + psql (13.4 (Ubuntu 13.4-1.pgdg28.84+1), server 13.4.8 (Debian 13.4.8-1+deb10)) + WARNING : psql major version 13, server major version 13. Some psql features might not work. + SSL connection (protocol : TLSV1.3cipherTLS_AES_256_GCM_SHA384, bits : 256, compression : off) Type "help" for help. - edb_admin=> -``` + edb_admin=> + ``` ### Create a VPC peering connection with a VPC in a different region @@ -132,13 +133,14 @@ You can create a VPC peering connection with a VPC in the same region or a diffe 1. Access the cluster with its domain name from your cluster's connection string. It's accessible from `vpc-client` after peering. -```shell - $ psql -h vpce-XXXXXXXXXXXXXXXXXXXX.eu-west-1.vpce.amazonaws.com -U edb_admin - Password for user edb_admin: + ```shell + psql -h vpce-XXXXXXXXXXXXXXXXXXXX.eu-west-1.vpce.amazonaws.com -U edb_admin + __OUTPUT__ + Password for user edb_admin: - psql (13.4 (Ubuntu 13.4-1.pgdg28.84+1), server 13.4.8 (Debian 13.4.8-1+deb10)) - WARNING : psql major version 13, server major version 13. Some psql features might not work. - SSL connection (protocol : TLSV1.3cipherTLS_AES_256_GCM_SHA384, bits : 256, compression : off) Type "help" for help. + psql (13.4 (Ubuntu 13.4-1.pgdg28.84+1), server 13.4.8 (Debian 13.4.8-1+deb10)) + WARNING : psql major version 13, server major version 13. Some psql features might not work. + SSL connection (protocol : TLSV1.3cipherTLS_AES_256_GCM_SHA384, bits : 256, compression : off) Type "help" for help. - edb_admin=> -``` + edb_admin=> + ``` From 032d09addf4f865623137eb9cf01dd26b6429744 Mon Sep 17 00:00:00 2001 From: Josh Heyer Date: Wed, 10 Aug 2022 00:14:11 +0000 Subject: [PATCH 13/16] Make output listings w/ box characters not look like crap --- src/styles/_docs.scss | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/styles/_docs.scss b/src/styles/_docs.scss index fe46546f795..3abe4f18798 100644 --- a/src/styles/_docs.scss +++ b/src/styles/_docs.scss @@ -129,6 +129,9 @@ label.link-label { background: #d1d1d1; color: #272822; text-shadow: none; + line-height: normal; + // Google doesn't serve some character ranges for Source Code Pro that we need for legible output, e.g. table listings - so use default + font-family: monospace !important; } } @@ -172,7 +175,6 @@ html.katacoda-panel-active .katacoda-exec-button { } @media print { - .topbar, .sidebar, nav { @@ -262,4 +264,4 @@ html.katacoda-panel-active .katacoda-exec-button { & span:hover { border-bottom: 1px solid grey; } -} \ No newline at end of file +} From d6a50bf34bb4958d3b20438c9f164e45010a6dc9 Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Wed, 10 Aug 2022 16:20:40 -0400 Subject: [PATCH 14/16] Revert "Changes to template files and generated files for MySQL" This reverts commit af96ca621e33b7bbda9d2b3163940ec4db637381. --- install_template/config.yaml | 8 +- install_template/deploy.mjs | 24 +---- .../almalinux-8-or-rocky-linux-8.njk | 25 ++---- .../mysql-foreign-data-wrapper/centos-7.njk | 17 +--- .../rhel-7-or-ol-7.njk | 17 +--- .../rhel-8-or-ol-8.njk | 4 +- .../rhel-8_ppc64le.njk | 3 - .../ibm_power_ppc64le/mysql_rhel8_ppcle.mdx | 72 ++++++++++----- .../x86_amd64/mysql_centos7_x86.mdx | 80 +++++++++++------ .../x86_amd64/mysql_other_linux8_x86.mdx | 69 ++++++++++----- .../x86_amd64/mysql_rhel7_x86.mdx | 87 ++++++++++++------- .../x86_amd64/mysql_rhel8_x86.mdx | 70 ++++++++++----- 12 files changed, 268 insertions(+), 208 deletions(-) delete mode 100644 install_template/templates/products/mysql-foreign-data-wrapper/rhel-8_ppc64le.njk diff --git a/install_template/config.yaml b/install_template/config.yaml index 2e90bdd4aef..2a0c4b038cf 100644 --- a/install_template/config.yaml +++ b/install_template/config.yaml @@ -487,6 +487,9 @@ products: - name: CentOS 7 arch: x86_64 supported versions: [2] + - name: CentOS 7 + arch: ppc64le + supported versions: [2] - name: AlmaLinux 8 or Rocky Linux 8 arch: x86_64 supported versions: [2] @@ -495,10 +498,7 @@ products: supported versions: [2] - name: RHEL 8 or OL 8 arch: x86_64 - supported versions: [2] - - name: RHEL 8 - arch: ppc64le - supported versions: [2] + supported versions: [11, 12, 13, 14] - name: Ubuntu 18.04 arch: x86_64 supported versions: [2] diff --git a/install_template/deploy.mjs b/install_template/deploy.mjs index 4f5be102f4c..1f7b31a3c1e 100644 --- a/install_template/deploy.mjs +++ b/install_template/deploy.mjs @@ -262,29 +262,7 @@ const moveDoc = async (product, platform, version) => { (ctx) => `mysql_data_adapter/2/04_installing_the_mysql_data_adapter/${fmtArchPath(ctx)}/mysql_ubuntu18_${fmtArchFilename(ctx)}.mdx`), when({product: {name: "MySQL Foreign Data Wrapper", version: 2}, platform: {name: "Ubuntu 20.04"}}, (ctx) => `mysql_data_adapter/2/04_installing_the_mysql_data_adapter/${fmtArchPath(ctx)}/mysql_ubuntu20_${fmtArchFilename(ctx)}.mdx`), - when({product: {name: "MySQL Foreign Data Wrapper", version: 2}, platform: {name: "CentOS 7"}}, - (ctx) => `mysql_data_adapter/2/04_installing_the_mysql_data_adapter/${fmtArchPath(ctx)}/mysql_centos7_${fmtArchFilename(ctx)}.mdx`), - when({product: {name: "MySQL Foreign Data Wrapper", version: 2}, platform: {name: "AlmaLinux 8 or Rocky Linux 8"}}, - (ctx) => `mysql_data_adapter/2/04_installing_the_mysql_data_adapter/${fmtArchPath(ctx)}/mysql_other_linux8_${fmtArchFilename(ctx)}.mdx`), - when({product: {name: "MySQL Foreign Data Wrapper", version: 2}, platform: {name: "RHEL 7 or OL 7"}}, - (ctx) => `mysql_data_adapter/2/04_installing_the_mysql_data_adapter/${fmtArchPath(ctx)}/mysql_rhel7_${fmtArchFilename(ctx)}.mdx`), - when({product: {name: "MySQL Foreign Data Wrapper", version: 2}, platform: {name: "RHEL 8 or OL 8"}}, - (ctx) => `mysql_data_adapter/2/04_installing_the_mysql_data_adapter/${fmtArchPath(ctx)}/mysql_rhel8_${fmtArchFilename(ctx)}.mdx`), - when({product: {name: "MySQL Foreign Data Wrapper", version: 2}, platform: {name: "RHEL 8"}}, - (ctx) => `mysql_data_adapter/2/04_installing_the_mysql_data_adapter/${fmtArchPath(ctx)}/mysql_rhel8_${fmtArchFilename(ctx)}.mdx`), - - - - - - - - - - - - - when({product: {name: "EDB OCL Connector"}, platform: {name: "SLES 12"}}, + when({product: {name: "EDB OCL Connector"}, platform: {name: "SLES 12"}}, (ctx) => `ocl_connector/${ctx.product.version}/04_open_client_library/01_installing_and_configuring_the_ocl_connector/install_on_linux_using_edb_repo/${fmtArchPath(ctx)}/ocl_connector14_sles12_${fmtArchFilename(ctx)}.mdx`), when({product: {name: "EDB OCL Connector"}, platform: {name: "SLES 15"}}, (ctx) => `ocl_connector/${ctx.product.version}/04_open_client_library/01_installing_and_configuring_the_ocl_connector/install_on_linux_using_edb_repo/${fmtArchPath(ctx)}/ocl_connector14_sles15_${fmtArchFilename(ctx)}.mdx`), diff --git a/install_template/templates/products/mysql-foreign-data-wrapper/almalinux-8-or-rocky-linux-8.njk b/install_template/templates/products/mysql-foreign-data-wrapper/almalinux-8-or-rocky-linux-8.njk index 152d0a5b05a..6a52895a4e5 100644 --- a/install_template/templates/products/mysql-foreign-data-wrapper/almalinux-8-or-rocky-linux-8.njk +++ b/install_template/templates/products/mysql-foreign-data-wrapper/almalinux-8-or-rocky-linux-8.njk @@ -1,23 +1,10 @@ {% extends "products/mysql-foreign-data-wrapper/base.njk" %} {% set platformBaseTemplate = "almalinux-8-or-rocky-linux-8" %} -{% set packageManager = "dnf" %} {% block prerequisites %} -```shell -# Set up the EDB repository: -{{ packageManager }} -y install https://yum.enterprisedb.com/edbrepos/edb-repo-latest.noarch.rpm - -# Replace '' and '' below with -# your username and password for the EDB repository: -sed -i "s@:@USERNAME:PASSWORD@" /etc/yum.repos.d/edb.repo - -# Install the EPEL repository: -{{ packageManager }} -y install "https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm" - -{% block redhatConfig %}# Enable additional repositories to resolve dependencies: -dnf config-manager --set-enabled PowerTools{% endblock redhatConfig %} -``` -{% endblock prerequisites %} - - - +{{ super() }} +1. Disable the built-in PostgreSQL module: + ```sh + dnf -qy module disable postgresql + ``` +{% endblock prerequisites %} \ No newline at end of file diff --git a/install_template/templates/products/mysql-foreign-data-wrapper/centos-7.njk b/install_template/templates/products/mysql-foreign-data-wrapper/centos-7.njk index 8d3a1573e62..3b83c16d289 100644 --- a/install_template/templates/products/mysql-foreign-data-wrapper/centos-7.njk +++ b/install_template/templates/products/mysql-foreign-data-wrapper/centos-7.njk @@ -1,17 +1,2 @@ {% extends "products/mysql-foreign-data-wrapper/base.njk" %} -{% set platformBaseTemplate = "centos-7" %} -{% block installCommand %} -```shell -# Download and install the MySQL repo: -{{packageManager}} -y install https://dev.mysql.com/get/mysql80-community-release-el7-3.noarch.rpm - -# For MySQL 8, enable the appropriate subrepository and install -# the MySQL Foreign data Wrapper: -yum -y install --enablerepo=mysql80-community --disablerepo=mysql57-community edb-as-mysql_fdw - -# For MySQL 5, enable the appropriate subrepository and install -# the MySQL Foreign data Wrapper: -{{packageManager}} -y install --enablerepo=mysql57-community --disablerepo=mysql80-community edb-as-mysql_fdw -``` -Where `` is the version of EDB Postgres Advanced server and `` is the version of MySQL to be installed. For example if EDB Postgres Version is 13 and MySQL version is 8 then the package name is `edb-as13-mysql8-fdw`. -{% endblock installCommand %} \ No newline at end of file +{% set platformBaseTemplate = "centos-7" %} \ No newline at end of file diff --git a/install_template/templates/products/mysql-foreign-data-wrapper/rhel-7-or-ol-7.njk b/install_template/templates/products/mysql-foreign-data-wrapper/rhel-7-or-ol-7.njk index 9f1d4b4a07d..3e29f41d483 100644 --- a/install_template/templates/products/mysql-foreign-data-wrapper/rhel-7-or-ol-7.njk +++ b/install_template/templates/products/mysql-foreign-data-wrapper/rhel-7-or-ol-7.njk @@ -1,17 +1,2 @@ {% extends "products/mysql-foreign-data-wrapper/base.njk" %} -{% set platformBaseTemplate = "rhel-7-or-ol-7" %} -{% block installCommand %} -```shell -# Download and install the MySQL repo: -{{packageManager}} -y install https://dev.mysql.com/get/mysql80-community-release-el7-3.noarch.rpm - -# For MySQL 8, enable the appropriate subrepository and install -# the MySQL Foreign data Wrapper: -yum -y install --enablerepo=mysql80-community --disablerepo=mysql57-community edb-as-mysql_fdw - -# For MySQL 5, enable the appropriate subrepository and install -# the MySQL Foreign data Wrapper: -{{packageManager}} -y install --enablerepo=mysql57-community --disablerepo=mysql80-community edb-as-mysql_fdw -``` -Where `` is the version of EDB Postgres Advanced server and `` is the version of MySQL to be installed. For example if EDB Postgres Version is 13 and MySQL version is 8 then the package name is `edb-as13-mysql8-fdw`. -{% endblock installCommand %} \ No newline at end of file +{% set platformBaseTemplate = "rhel-7-or-ol-7" %} \ No newline at end of file diff --git a/install_template/templates/products/mysql-foreign-data-wrapper/rhel-8-or-ol-8.njk b/install_template/templates/products/mysql-foreign-data-wrapper/rhel-8-or-ol-8.njk index e0796563739..cd91fd8d8d3 100644 --- a/install_template/templates/products/mysql-foreign-data-wrapper/rhel-8-or-ol-8.njk +++ b/install_template/templates/products/mysql-foreign-data-wrapper/rhel-8-or-ol-8.njk @@ -1,4 +1,2 @@ {% extends "products/mysql-foreign-data-wrapper/base.njk" %} -{% set platformBaseTemplate = "rhel-8-or-ol-8" %} -{% block redhatConfig %}# Enable additional repositories to resolve dependencies: -ARCH=$( /bin/arch ) subscription-manager repos --enable "codeready-builder-for-rhel-8-${ARCH}-rpms"{% endblock redhatConfig %} \ No newline at end of file +{% set platformBaseTemplate = "rhel-8-or-ol-8" %} \ No newline at end of file diff --git a/install_template/templates/products/mysql-foreign-data-wrapper/rhel-8_ppc64le.njk b/install_template/templates/products/mysql-foreign-data-wrapper/rhel-8_ppc64le.njk deleted file mode 100644 index b8c72f9d057..00000000000 --- a/install_template/templates/products/mysql-foreign-data-wrapper/rhel-8_ppc64le.njk +++ /dev/null @@ -1,3 +0,0 @@ -{% extends "products/mysql-foreign-data-wrapper/base.njk" %} -{% set platformBaseTemplate = "rhel-8-or-ol-8" %} -{% set includePPC = true %} diff --git a/product_docs/docs/mysql_data_adapter/2/04_installing_the_mysql_data_adapter/ibm_power_ppc64le/mysql_rhel8_ppcle.mdx b/product_docs/docs/mysql_data_adapter/2/04_installing_the_mysql_data_adapter/ibm_power_ppc64le/mysql_rhel8_ppcle.mdx index 5ef3b7e9732..1e737a1ce8f 100644 --- a/product_docs/docs/mysql_data_adapter/2/04_installing_the_mysql_data_adapter/ibm_power_ppc64le/mysql_rhel8_ppcle.mdx +++ b/product_docs/docs/mysql_data_adapter/2/04_installing_the_mysql_data_adapter/ibm_power_ppc64le/mysql_rhel8_ppcle.mdx @@ -1,44 +1,68 @@ --- -navTitle: RHEL 8 -title: Installing MySQL Foreign Data Wrapper on RHEL 8 ppc64le +title: "Installing MySQL Foreign Data Wrapper on RHEL 8 IBM Power (ppc64le)" +navTitle: "RHEL 8" --- -Before you begin the installation process, log in as superuser. +There are two steps to completing an installation: + +- Setting up the repository +- Installing the package + +For each step, you must be logged in as superuser. + +To log in as a superuser: ```shell -# To log in as a superuser: sudo su - ``` -## Set up the repository +## Setting up the repository -Setting up the repository is a one-time task. If you have already set up your repository, you do not need to perform this step. If you do need to set up the repository, you must register with EDB. To receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request). +1. To register with EDB to receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request). -```shell -# Set up the EDB repository: -dnf -y install https://yum.enterprisedb.com/edbrepos/edb-repo-latest.noarch.rpm +1. Set up the EDB repository: -# Replace '' and '' below with -# your username and password for the EDB repository: -sed -i "s@:@USERNAME:PASSWORD@" /etc/yum.repos.d/edb.repo + ```shell + dnf -y install https://yum.enterprisedb.com/edbrepos/edb-repo-latest.noarch.rpm + ``` -# Install the EPEL repository: -dnf -y install https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm + This creates the /etc/yum.repos.d/edb.repo configuration file. -# Refresh the cache: -dnf makecache +1. Add your EDB credentials to the edb.repo file: -# Enable additional repositories to resolve dependencies: -ARCH=$( /bin/arch ) subscription-manager repos --enable "codeready-builder-for-rhel-8-${ARCH}-rpms" + ```shell + sed -i "s@:@USERNAME:PASSWORD@" /etc/yum.repos.d/edb.repo + ``` -# Disable the built-in PostgreSQL module: -dnf -qy module disable postgresql -``` + Where `USERNAME:PASSWORD` is the username and password available from your + [EDB account](https://www.enterprisedb.com/user). + +1. Install the EPEL repository and refresh the cache: + + ```shell + dnf -y install https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm + dnf makecache + ``` -## Install the package +1. Enable the codeready-builder-for-rhel-8-\*-rpms repository since EPEL packages may depend on packages from it: + + ```shell + ARCH=$( /bin/arch ) + subscription-manager repos --enable "codeready-builder-for-rhel-8-${ARCH}-rpms" + ``` + +1. Disable the built-in PostgreSQL module: + ```shell + dnf -qy module disable postgresql + ``` + +## Installing the package ```shell -dnf -y install edb-as-mysql-fdw +dnf -y install edb-as-mysql8_fdw ``` -Where `` is the version of EDB Postgres Advanced server and `` is the version of MySQL to be installed. For example if EDB Postgres Version is 13 and MySQL version is 8 then the package name is `edb-as13-mysql8-fdw`. +where `xx` is the server version number. + + + diff --git a/product_docs/docs/mysql_data_adapter/2/04_installing_the_mysql_data_adapter/x86_amd64/mysql_centos7_x86.mdx b/product_docs/docs/mysql_data_adapter/2/04_installing_the_mysql_data_adapter/x86_amd64/mysql_centos7_x86.mdx index fcd01cbb19d..4c85d3b47dc 100644 --- a/product_docs/docs/mysql_data_adapter/2/04_installing_the_mysql_data_adapter/x86_amd64/mysql_centos7_x86.mdx +++ b/product_docs/docs/mysql_data_adapter/2/04_installing_the_mysql_data_adapter/x86_amd64/mysql_centos7_x86.mdx @@ -1,46 +1,72 @@ --- -navTitle: CentOS 7 -title: Installing MySQL Foreign Data Wrapper on CentOS 7 x86_64 +title: "Installing MySQL Foreign Data Wrapper on CentOS 7 x86" +navTitle: "CentOS 7" --- -Before you begin the installation process, log in as superuser. +Before installing the MySQL Foreign Data Wrapper, you must install the following prerequisite packages, and request credentials from EDB: -```shell -# To log in as a superuser: -sudo su - +Install the `epel-release` package: + +```text +yum -y install https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm ``` -## Set up the repository +You may need to enable the `[extras]` repository definition in the `CentOS-Base.repo` file (located in `/etc/yum.repos.d`). -Setting up the repository is a one-time task. If you have already set up your repository, you do not need to perform this step. If you do need to set up the repository, you must register with EDB. To receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request). +You must also have credentials that allow access to the EDB repository. For information about requesting credentials, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request). -```shell -# Set up the EDB repository: -yum -y install https://yum.enterprisedb.com/edbrepos/edb-repo-latest.noarch.rpm +After receiving your repository credentials you can: -# Replace '' and '' below with -# your username and password for the EDB repository: -sed -i "s@:@USERNAME:PASSWORD@" /etc/yum.repos.d/edb.repo +1. Create the repository configuration file. +2. Modify the file, providing your user name and password. +3. Install the MySQL Foreign Data Wrapper. -# Install the EPEL repository: -yum -y install https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm +## Creating a repository configuration file +To create the repository configuration file, assume superuser privileges, and invoke the following command: +```text +yum -y install https://yum.enterprisedb.com/edbrepos/edb-repo-latest.noarch.rpm ``` -## Install the package +The repository configuration file is named `edb.repo`. The file resides in `/etc/yum.repos.d`. -```shell -# Download and install the MySQL repo: -yum -y install https://dev.mysql.com/get/mysql80-community-release-el7-3.noarch.rpm +## Modifying the file, providing your user name and password -# For MySQL 8, enable the appropriate subrepository and install -# the MySQL Foreign data Wrapper: -yum -y install --enablerepo=mysql80-community --disablerepo=mysql57-community edb-as-mysql_fdw +After creating the `edb.repo` file, use your choice of editor to ensure that the value of the `enabled` parameter is `1`, and replace the `username` and `password` placeholders in the `baseurl` specification with the name and password of a registered EDB user. -# For MySQL 5, enable the appropriate subrepository and install -# the MySQL Foreign data Wrapper: -yum -y install --enablerepo=mysql57-community --disablerepo=mysql80-community edb-as-mysql_fdw +```text +[edb] +name=EnterpriseDB RPMs $releasever - $basearch +baseurl=https://:@yum.enterprisedb.com/edb/redhat/rhel-$releasever-$basearch +enabled=1 +gpgcheck=1 +repo_gpgcheck=1 +gpgkey=file:///etc/pki/rpm-gpg/ENTERPRISEDB-GPG-KEY ``` -Where `` is the version of EDB Postgres Advanced server and `` is the version of MySQL to be installed. For example if EDB Postgres Version is 13 and MySQL version is 8 then the package name is `edb-as13-mysql8-fdw`. +## Installing MySQL Foreign Data Wrapper + +1. Before installing MySQL FDW, download and install the MySQL repo using the following commands: + + ```text + yum -y install https://dev.mysql.com/get/mysql80-community-release-el7-3.noarch.rpm + ``` + +2. Use the following command to enable the appropriate subrepository and install the MySQL Foreign data Wrapper: + - For MySQL 8: + ```text + yum -y install --enablerepo=mysql80-community --disablerepo=mysql57-community edb-as-mysql8_fdw + ``` + - For MySQL 5: + ```text + yum -y install --enablerepo=mysql57-community --disablerepo=mysql80-community edb-as-mysql5_fdw + ``` +Where `xx` is the server version number i.e. 13. + +When you install an RPM package that is signed by a source that is not recognized by your system, yum may ask for your permission to import the key to your local server. If prompted, and you are satisfied that the packages come from a trustworthy source, enter `y`, and press `Return` to continue. + +During the installation, yum may encounter a dependency that it cannot resolve. If it does, it will provide a list of the required dependencies that you must manually resolve. + + + diff --git a/product_docs/docs/mysql_data_adapter/2/04_installing_the_mysql_data_adapter/x86_amd64/mysql_other_linux8_x86.mdx b/product_docs/docs/mysql_data_adapter/2/04_installing_the_mysql_data_adapter/x86_amd64/mysql_other_linux8_x86.mdx index 7143a894acb..86d4ab1ae42 100644 --- a/product_docs/docs/mysql_data_adapter/2/04_installing_the_mysql_data_adapter/x86_amd64/mysql_other_linux8_x86.mdx +++ b/product_docs/docs/mysql_data_adapter/2/04_installing_the_mysql_data_adapter/x86_amd64/mysql_other_linux8_x86.mdx @@ -1,38 +1,63 @@ --- -navTitle: AlmaLinux 8 or Rocky Linux 8 -title: Installing MySQL Foreign Data Wrapper on AlmaLinux 8 or Rocky Linux 8 x86_64 +title: "Installing MySQL Foreign Data Wrapper on Rocky Linux 8/AlmaLinux 8 x86" +navTitle: "Rocky Linux 8/AlmaLinux 8" --- -Before you begin the installation process, log in as superuser. +Before installing the MySQL Foreign Data Wrapper, you must install the following prerequisite packages, and request credentials from EDB: -```shell -# To log in as a superuser: -sudo su - +Install the `epel-release` package: + +```text +dnf -y install https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm ``` -## Set up the repository +Enable the `PowerTools` repository: -Setting up the repository is a one-time task. If you have already set up your repository, you do not need to perform this step. If you do need to set up the repository, you must register with EDB. To receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request). +```text +dnf config-manager --set-enabled PowerTools +``` -```shell -# Set up the EDB repository: -dnf -y install https://yum.enterprisedb.com/edbrepos/edb-repo-latest.noarch.rpm +You must also have credentials that allow access to the EDB repository. For information about requesting credentials, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request). -# Replace '' and '' below with -# your username and password for the EDB repository: -sed -i "s@:@USERNAME:PASSWORD@" /etc/yum.repos.d/edb.repo +After receiving your repository credentials you can: -# Install the EPEL repository: -dnf -y install "https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm" +1. Create the repository configuration file. +2. Modify the file, providing your user name and password. +3. Install the MySQL Foreign Data Wrapper. -# Enable additional repositories to resolve dependencies: -dnf config-manager --set-enabled PowerTools +## Creating a repository configuration file + +To create the repository configuration file, assume superuser privileges, and invoke the following command: + +```text +dnf -y https://yum.enterprisedb.com/edbrepos/edb-repo-latest.noarch.rpm ``` -## Install the package +The repository configuration file is named `edb.repo`. The file resides in `/etc/yum.repos.d`. + +## Modifying the file, providing your user name and password -```shell -dnf -y install edb-as-mysql-fdw +After creating the `edb.repo` file, use your choice of editor to ensure that the value of the `enabled` parameter is `1`, and replace the `username` and `password` placeholders in the `baseurl` specification with the name and password of a registered EDB user. + +```text +[edb] +name=EnterpriseDB RPMs $releasever - $basearch +baseurl=https://:@yum.enterprisedb.com/edb/redhat/rhel-$releasever-$basearch +enabled=1 +gpgcheck=1 +repo_gpgcheck=1 +gpgkey=file:///etc/pki/rpm-gpg/ENTERPRISEDB-GPG-KEY +``` +## Installing MySQL Foreign Data Wrapper + +After saving your changes to the configuration file, use the below command to install the MySQL Foreign Data Wrapper: + +```text +dnf install edb-as-mysql8_fdw ``` +Where `xx` is the server version number i.e. 13. + +When you install an RPM package that is signed by a source that is not recognized by your system, yum may ask for your permission to import the key to your local server. If prompted, and you are satisfied that the packages come from a trustworthy source, enter `y`, and press `Return` to continue. + +During the installation, yum may encounter a dependency that it cannot resolve. If it does, it will provide a list of the required dependencies that you must manually resolve. -Where `` is the version of EDB Postgres Advanced server and `` is the version of MySQL to be installed. For example if EDB Postgres Version is 13 and MySQL version is 8 then the package name is `edb-as13-mysql8-fdw`. diff --git a/product_docs/docs/mysql_data_adapter/2/04_installing_the_mysql_data_adapter/x86_amd64/mysql_rhel7_x86.mdx b/product_docs/docs/mysql_data_adapter/2/04_installing_the_mysql_data_adapter/x86_amd64/mysql_rhel7_x86.mdx index b42a41d441e..13a5698c7cf 100644 --- a/product_docs/docs/mysql_data_adapter/2/04_installing_the_mysql_data_adapter/x86_amd64/mysql_rhel7_x86.mdx +++ b/product_docs/docs/mysql_data_adapter/2/04_installing_the_mysql_data_adapter/x86_amd64/mysql_rhel7_x86.mdx @@ -1,47 +1,76 @@ --- -navTitle: RHEL 7 or OL 7 -title: Installing MySQL Foreign Data Wrapper on RHEL 7 or OL 7 x86_64 +title: "Installing MySQL Foreign Data Wrapper on RHEL 7/OL 7 x86" +navTitle: "RHEL 7/OL 7" --- -Before you begin the installation process, log in as superuser. +Before installing the MySQL Foreign Data Wrapper, you must install the following prerequisite packages, and request credentials from EDB: -```shell -# To log in as a superuser: -sudo su - +Install the `epel-release` package: + +```text +yum -y install https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm ``` -## Set up the repository +Enable the optional, extras, and HA repositories: -Setting up the repository is a one-time task. If you have already set up your repository, you do not need to perform this step. If you do need to set up the repository, you must register with EDB. To receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request). +```text +subscription-manager repos --enable "rhel-*-optional-rpms" --enable "rhel-*-extras-rpms" --enable "rhel-ha-for-rhel-*-server-rpms" +``` -```shell -# Set up the EDB repository: -yum -y install https://yum.enterprisedb.com/edbrepos/edb-repo-latest.noarch.rpm +You must also have credentials that allow access to the EDB repository. For information about requesting credentials, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request). -# Replace '' and '' below with -# your username and password for the EDB repository: -sed -i "s@:@USERNAME:PASSWORD@" /etc/yum.repos.d/edb.repo +After receiving your repository credentials you can: -# Install the EPEL repository: -yum -y install https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm +1. Create the repository configuration file. +2. Modify the file, providing your user name and password. +3. Install the MySQL Foreign Data Wrapper. -# Enable additional repositories to resolve dependencies: -subscription-manager repos --enable "rhel-*-optional-rpms" --enable "rhel-*-extras-rpms" --enable "rhel-ha-for-rhel-*-server-rpms" +## Creating a repository configuration file + +To create the repository configuration file, assume superuser privileges, and invoke the following command: + +```text +yum -y install https://yum.enterprisedb.com/edbrepos/edb-repo-latest.noarch.rpm ``` -## Install the package +The repository configuration file is named `edb.repo`. The file resides in `/etc/yum.repos.d`. -```shell -# Download and install the MySQL repo: -yum -y install https://dev.mysql.com/get/mysql80-community-release-el7-3.noarch.rpm +## Modifying the file, providing your user name and password -# For MySQL 8, enable the appropriate subrepository and install -# the MySQL Foreign data Wrapper: -yum -y install --enablerepo=mysql80-community --disablerepo=mysql57-community edb-as-mysql_fdw +After creating the `edb.repo` file, use your choice of editor to ensure that the value of the `enabled` parameter is `1`, and replace the `username` and `password` placeholders in the `baseurl` specification with the name and password of a registered EDB user. -# For MySQL 5, enable the appropriate subrepository and install -# the MySQL Foreign data Wrapper: -yum -y install --enablerepo=mysql57-community --disablerepo=mysql80-community edb-as-mysql_fdw +```text +[edb] +name=EnterpriseDB RPMs $releasever - $basearch +baseurl=https://:@yum.enterprisedb.com/edb/redhat/rhel-$releasever-$basearch +enabled=1 +gpgcheck=1 +repo_gpgcheck=1 +gpgkey=file:///etc/pki/rpm-gpg/ENTERPRISEDB-GPG-KEY ``` -Where `` is the version of EDB Postgres Advanced server and `` is the version of MySQL to be installed. For example if EDB Postgres Version is 13 and MySQL version is 8 then the package name is `edb-as13-mysql8-fdw`. +## Installing MySQL Foreign Data Wrapper + +1. Before installing MySQL FDW, download and install the MySQL repo using the following commands: + + ```text + yum -y install https://dev.mysql.com/get/mysql80-community-release-el7-3.noarch.rpm + ``` + +2. Use the following command to enable the appropriate subrepository and install the MySQL Foreign data Wrapper: + - For MySQL 8: + ```text + yum -y install --enablerepo=mysql80-community --disablerepo=mysql57-community edb-as-mysql8_fdw + ``` + - For MySQL 5: + ```text + yum -y install --enablerepo=mysql57-community --disablerepo=mysql80-community edb-as-mysql5_fdw + ``` +Where `xx` is the server version number i.e. 13. + +When you install an RPM package that is signed by a source that is not recognized by your system, yum may ask for your permission to import the key to your local server. If prompted, and you are satisfied that the packages come from a trustworthy source, enter `y`, and press `Return` to continue. + +During the installation, yum may encounter a dependency that it cannot resolve. If it does, it will provide a list of the required dependencies that you must manually resolve. + + + diff --git a/product_docs/docs/mysql_data_adapter/2/04_installing_the_mysql_data_adapter/x86_amd64/mysql_rhel8_x86.mdx b/product_docs/docs/mysql_data_adapter/2/04_installing_the_mysql_data_adapter/x86_amd64/mysql_rhel8_x86.mdx index 5dad2ab5ed2..12ec03092a3 100644 --- a/product_docs/docs/mysql_data_adapter/2/04_installing_the_mysql_data_adapter/x86_amd64/mysql_rhel8_x86.mdx +++ b/product_docs/docs/mysql_data_adapter/2/04_installing_the_mysql_data_adapter/x86_amd64/mysql_rhel8_x86.mdx @@ -1,38 +1,64 @@ --- -navTitle: RHEL 8 or OL 8 -title: Installing MySQL Foreign Data Wrapper on RHEL 8 or OL 8 x86_64 +title: "Installing MySQL Foreign Data Wrapper on RHEL 8/OL 8 x86" +navTitle: "RHEL 8/OL 8" --- -Before you begin the installation process, log in as superuser. +Before installing the MySQL Foreign Data Wrapper, you must install the following prerequisite packages, and request credentials from EDB: -```shell -# To log in as a superuser: -sudo su - +Install the `epel-release` package: + +```text +dnf -y install https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm ``` -## Set up the repository +Enable the `codeready-builder-for-rhel-8-\*-rpms` repository: -Setting up the repository is a one-time task. If you have already set up your repository, you do not need to perform this step. If you do need to set up the repository, you must register with EDB. To receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request). +```text +ARCH=$( /bin/arch ) +subscription-manager repos --enable "codeready-builder-for-rhel-8-${ARCH}-rpms" +``` -```shell -# Set up the EDB repository: -dnf -y install https://yum.enterprisedb.com/edbrepos/edb-repo-latest.noarch.rpm +You must also have credentials that allow access to the EDB repository. For information about requesting credentials, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request). -# Replace '' and '' below with -# your username and password for the EDB repository: -sed -i "s@:@USERNAME:PASSWORD@" /etc/yum.repos.d/edb.repo +After receiving your repository credentials you can: -# Install the EPEL repository: -dnf -y install https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm +1. Create the repository configuration file. +2. Modify the file, providing your user name and password. +3. Install the MySQL Foreign Data Wrapper. -# Enable additional repositories to resolve dependencies: -ARCH=$( /bin/arch ) subscription-manager repos --enable "codeready-builder-for-rhel-8-${ARCH}-rpms" +## Creating a repository configuration file + +To create the repository configuration file, assume superuser privileges, and invoke the following command: + +```text +dnf -y https://yum.enterprisedb.com/edbrepos/edb-repo-latest.noarch.rpm ``` -## Install the package +The repository configuration file is named `edb.repo`. The file resides in `/etc/yum.repos.d`. + +## Modifying the file, providing your user name and password -```shell -dnf -y install edb-as-mysql-fdw +After creating the `edb.repo` file, use your choice of editor to ensure that the value of the `enabled` parameter is `1`, and replace the `username` and `password` placeholders in the `baseurl` specification with the name and password of a registered EDB user. + +```text +[edb] +name=EnterpriseDB RPMs $releasever - $basearch +baseurl=https://:@yum.enterprisedb.com/edb/redhat/rhel-$releasever-$basearch +enabled=1 +gpgcheck=1 +repo_gpgcheck=1 +gpgkey=file:///etc/pki/rpm-gpg/ENTERPRISEDB-GPG-KEY +``` +## Installing MySQL Foreign Data Wrapper + +After saving your changes to the configuration file, use the below command to install the MySQL Foreign Data Wrapper: + +```text +dnf install edb-as-mysql8_fdw ``` +Where `xx` is the server version number i.e. 13. + +When you install an RPM package that is signed by a source that is not recognized by your system, yum may ask for your permission to import the key to your local server. If prompted, and you are satisfied that the packages come from a trustworthy source, enter `y`, and press `Return` to continue. + +During the installation, yum may encounter a dependency that it cannot resolve. If it does, it will provide a list of the required dependencies that you must manually resolve. -Where `` is the version of EDB Postgres Advanced server and `` is the version of MySQL to be installed. For example if EDB Postgres Version is 13 and MySQL version is 8 then the package name is `edb-as13-mysql8-fdw`. From 7712fa421cfce2144e30b68b3998add69ecb70cd Mon Sep 17 00:00:00 2001 From: cnp-autobot Date: Wed, 10 Aug 2022 19:15:43 +0000 Subject: [PATCH 15/16] [create-pull-request] automated change --- .../1/api_reference.mdx | 52 +++--- .../postgres_for_kubernetes/1/bootstrap.mdx | 35 +++- .../1/database_import.mdx | 9 +- .../docs/postgres_for_kubernetes/1/faq.mdx | 4 +- .../docs/postgres_for_kubernetes/1/index.mdx | 157 ++++++++++-------- .../1/license_keys.mdx | 2 +- .../1/operator_capability_levels.mdx | 6 + .../postgres_for_kubernetes/1/postgis.mdx | 155 +++++++++++++++++ .../postgres_for_kubernetes/1/quickstart.mdx | 33 ++-- .../postgres_for_kubernetes/1/samples.mdx | 8 + .../cluster-example-initdb-sql-refs.yaml | 47 ++++++ .../1/samples/postgis-example.yaml | 17 ++ .../1/ssl_connections.mdx | 4 +- .../1/troubleshooting.mdx | 28 +++- 14 files changed, 446 insertions(+), 111 deletions(-) create mode 100644 product_docs/docs/postgres_for_kubernetes/1/postgis.mdx create mode 100644 product_docs/docs/postgres_for_kubernetes/1/samples/cluster-example-initdb-sql-refs.yaml create mode 100644 product_docs/docs/postgres_for_kubernetes/1/samples/postgis-example.yaml diff --git a/product_docs/docs/postgres_for_kubernetes/1/api_reference.mdx b/product_docs/docs/postgres_for_kubernetes/1/api_reference.mdx index c5772930db9..f8b709a594a 100644 --- a/product_docs/docs/postgres_for_kubernetes/1/api_reference.mdx +++ b/product_docs/docs/postgres_for_kubernetes/1/api_reference.mdx @@ -69,6 +69,7 @@ Below you will find a description of the defined resources: - [PoolerSecrets](#PoolerSecrets) - [PoolerSpec](#PoolerSpec) - [PoolerStatus](#PoolerStatus) +- [PostInitApplicationSQLRefs](#PostInitApplicationSQLRefs) - [PostgresConfiguration](#PostgresConfiguration) - [RecoveryTarget](#RecoveryTarget) - [ReplicaClusterConfiguration](#ReplicaClusterConfiguration) @@ -208,9 +209,9 @@ BarmanCredentials an object containing the potential credentials for each cloud | Name | Description | Type | | ------------------- | ------------------------------------------------------------- | ----------------------------------------- | -| `googleCredentials` | The credentials to use to upload data to S3 | [\*GoogleCredentials](#GoogleCredentials) | -| `s3Credentials ` | The credentials to use to upload data to Azure Blob Storage | [\*S3Credentials](#S3Credentials) | -| `azureCredentials ` | The credentials to use to upload data to Google Cloud Storage | [\*AzureCredentials](#AzureCredentials) | +| `googleCredentials` | The credentials to use to upload data to Google Cloud Storage | [\*GoogleCredentials](#GoogleCredentials) | +| `s3Credentials ` | The credentials to use to upload data to S3 | [\*S3Credentials](#S3Credentials) | +| `azureCredentials ` | The credentials to use to upload data to Azure Blob Storage | [\*AzureCredentials](#AzureCredentials) | @@ -247,22 +248,23 @@ BootstrapConfiguration contains information about how to create the PostgreSQL c BootstrapInitDB is the configuration of the bootstrap process when initdb is used Refer to the Bootstrap page of the documentation for more information. -| Name | Description | Type | -| ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- | -| `database ` | Name of the database used by the application. Default: `app`. - *mandatory* | string | -| `owner ` | Name of the owner of the database in the instance to be used by applications. Defaults to the value of the `database` key. - *mandatory* | string | -| `secret ` | Name of the secret containing the initial credentials for the owner of the user database. If empty a new secret will be created from scratch | [\*LocalObjectReference](#LocalObjectReference) | -| `redwood ` | If we need to enable/disable Redwood compatibility. Requires EPAS and for EPAS defaults to true | \*bool | -| `options ` | The list of options that must be passed to initdb when creating the cluster. Deprecated: This could lead to inconsistent configurations, please use the explicit provided parameters instead. If defined, explicit values will be ignored. | \[]string | -| `dataChecksums ` | Whether the `-k` option should be passed to initdb, enabling checksums on data pages (default: `false`) | \*bool | -| `encoding ` | The value to be passed as option `--encoding` for initdb (default:`UTF8`) | string | -| `localeCollate ` | The value to be passed as option `--lc-collate` for initdb (default:`C`) | string | -| `localeCType ` | The value to be passed as option `--lc-ctype` for initdb (default:`C`) | string | -| `walSegmentSize ` | The value in megabytes (1 to 1024) to be passed to the `--wal-segsize` option for initdb (default: empty, resulting in PostgreSQL default: 16MB) | int | -| `postInitSQL ` | List of SQL queries to be executed as a superuser immediately after the cluster has been created - to be used with extreme care (by default empty) | \[]string | -| `postInitApplicationSQL` | List of SQL queries to be executed as a superuser in the application database right after is created - to be used with extreme care (by default empty) | \[]string | -| `postInitTemplateSQL ` | List of SQL queries to be executed as a superuser in the `template1` after the cluster has been created - to be used with extreme care (by default empty) | \[]string | -| `import ` | Bootstraps the new cluster by importing data from an existing PostgreSQL instance using logical backup (`pg_dump` and `pg_restore`) | [\*Import](#Import) | +| Name | Description | Type | +| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | +| `database ` | Name of the database used by the application. Default: `app`. - *mandatory* | string | +| `owner ` | Name of the owner of the database in the instance to be used by applications. Defaults to the value of the `database` key. - *mandatory* | string | +| `secret ` | Name of the secret containing the initial credentials for the owner of the user database. If empty a new secret will be created from scratch | [\*LocalObjectReference](#LocalObjectReference) | +| `redwood ` | If we need to enable/disable Redwood compatibility. Requires EPAS and for EPAS defaults to true | \*bool | +| `options ` | The list of options that must be passed to initdb when creating the cluster. Deprecated: This could lead to inconsistent configurations, please use the explicit provided parameters instead. If defined, explicit values will be ignored. | \[]string | +| `dataChecksums ` | Whether the `-k` option should be passed to initdb, enabling checksums on data pages (default: `false`) | \*bool | +| `encoding ` | The value to be passed as option `--encoding` for initdb (default:`UTF8`) | string | +| `localeCollate ` | The value to be passed as option `--lc-collate` for initdb (default:`C`) | string | +| `localeCType ` | The value to be passed as option `--lc-ctype` for initdb (default:`C`) | string | +| `walSegmentSize ` | The value in megabytes (1 to 1024) to be passed to the `--wal-segsize` option for initdb (default: empty, resulting in PostgreSQL default: 16MB) | int | +| `postInitSQL ` | List of SQL queries to be executed as a superuser immediately after the cluster has been created - to be used with extreme care (by default empty) | \[]string | +| `postInitApplicationSQL ` | List of SQL queries to be executed as a superuser in the application database right after is created - to be used with extreme care (by default empty) | \[]string | +| `postInitTemplateSQL ` | List of SQL queries to be executed as a superuser in the `template1` after the cluster has been created - to be used with extreme care (by default empty) | \[]string | +| `import ` | Bootstraps the new cluster by importing data from an existing PostgreSQL instance using logical backup (`pg_dump` and `pg_restore`) | [\*Import](#Import) | +| `postInitApplicationSQLRefs` | PostInitApplicationSQLRefs points references to ConfigMaps or Secrets which contain SQL files, the general implementation order to these references is from all Secrets to all ConfigMaps, and inside Secrets or ConfigMaps, the implementation order is same as the order of each array (by default empty) | [\*PostInitApplicationSQLRefs](#PostInitApplicationSQLRefs) | @@ -402,6 +404,7 @@ ClusterStatus defines the observed state of Cluster | `resizingPVC ` | List of all the PVCs that have ResizingPVC condition. | \[]string | | `initializingPVC ` | List of all the PVCs that are being initialized by this cluster | \[]string | | `healthyPVC ` | List of all the PVCs not dangling nor initializing | \[]string | +| `licenseStatus ` | Status of the license | licensekey.Status | | `writeService ` | Current write pod | string | | `readService ` | Current list of read pods | string | | `phase ` | Current phase of the cluster | string | @@ -753,6 +756,17 @@ PoolerStatus defines the observed state of Pooler | `secrets ` | The resource version of the config object | [\*PoolerSecrets](#PoolerSecrets) | | `instances` | The number of pods trying to be scheduled | int32 | + + +## PostInitApplicationSQLRefs + +PostInitApplicationSQLRefs points references to ConfigMaps or Secrets which contain SQL files, the general implementation order to these references is from all Secrets to all ConfigMaps, and inside Secrets or ConfigMaps, the implementation order is same as the order of each array + +| Name | Description | Type | +| --------------- | ------------------------------------------------------ | ------------------------------------------------- | +| `secretRefs ` | SecretRefs holds a list of references to Secrets | [\[\]SecretKeySelector](#SecretKeySelector) | +| `configMapRefs` | ConfigMapRefs holds a list of references to ConfigMaps | [\[\]ConfigMapKeySelector](#ConfigMapKeySelector) | + ## PostgresConfiguration diff --git a/product_docs/docs/postgres_for_kubernetes/1/bootstrap.mdx b/product_docs/docs/postgres_for_kubernetes/1/bootstrap.mdx index ff801ca872a..7375b8b5315 100644 --- a/product_docs/docs/postgres_for_kubernetes/1/bootstrap.mdx +++ b/product_docs/docs/postgres_for_kubernetes/1/bootstrap.mdx @@ -283,6 +283,39 @@ spec: as queries are run as a superuser and can disrupt the entire cluster. An error in any of those queries interrupts the bootstrap phase, leaving the cluster incomplete. +Moreover, you can specify a list of Secrets and/or ConfigMaps which contains SQL script that will be executed after the database is created and configured. These SQL script will be executed using the **superuser** role (`postgres`), connected to the database specified in the `initdb` section: + +```yaml +apiVersion: postgresql.k8s.enterprisedb.io/v1 +kind: Cluster +metadata: + name: cluster-example-initdb +spec: + instances: 3 + + bootstrap: + initdb: + database: app + owner: app + postInitApplicationSQLRefs: + secretRefs: + - name: my-secret + key: secret.sql + configMapRefs: + - name: my-configmap + key: configmap.sql + storage: + size: 1Gi +``` + +!!! Note + The SQL scripts referenced in `secretRefs` will be executed before the ones referenced in `configMapRefs`. For both sections the SQL scripts will be executed respecting the order in the list. + Inside SQL scripts, each SQL statement is executed in a single exec on the server according to the [PostgreSQL semantics](https://www.postgresql.org/docs/current/protocol-flow.html#PROTOCOL-FLOW-MULTI-STATEMENT), comments can be included, but internal command like `psql` cannot. + +!!! Warning + Please make sure the existence of the entries inside the ConfigMaps or Secrets specified in `postInitApplicationSQLRefs`, otherwise the bootstrap will fail. + Errors in any of those SQL files will prevent the bootstrap phase to complete successfully. + ### Compatibility Features EDB Postgres Advanced adds many compatibility features to the @@ -349,7 +382,7 @@ There are two ways to achieve this result in EDB Postgres for Kubernetes: only option available before version 1.8.0). Both recovery methods enable either full recovery (up to the last -available WAL) or up to a [point in time](#point-in-time-recovery). +available WAL) or up to a [point in time](#point-in-time-recovery-pitr). When performing a full recovery, the cluster can also be started in replica mode. diff --git a/product_docs/docs/postgres_for_kubernetes/1/database_import.mdx b/product_docs/docs/postgres_for_kubernetes/1/database_import.mdx index fc638e34fec..fcea6d97ed2 100644 --- a/product_docs/docs/postgres_for_kubernetes/1/database_import.mdx +++ b/product_docs/docs/postgres_for_kubernetes/1/database_import.mdx @@ -142,7 +142,8 @@ spec: There are a few things you need to be aware of when using the `microservice` type: - It requires an `externalCluster` that points to an existing PostgreSQL - instance containing the data to import + instance containing the data to import (for more information, please refer to + ["The `externalClusters` section"](bootstrap.md#the-externalclusters-section)) - Traffic must be allowed between the Kubernetes cluster and the `externalCluster` during the operation - Connection to the source database must be granted with the specified user @@ -208,6 +209,7 @@ spec: host: pg96.local user: postgres dbname: postgres + sslmode: require password: name: cluster-pg96-superuser key: password @@ -216,9 +218,12 @@ spec: There are a few things you need to be aware of when using the `monolith` type: - It requires an `externalCluster` that points to an existing PostgreSQL - instance containing the data to import + instance containing the data to import (for more information, please refer to + ["The `externalClusters` section"](bootstrap.md#the-externalclusters-section)) - Traffic must be allowed between the Kubernetes cluster and the `externalCluster` during the operation +- You need to specify `sslmode: disable` in the `connectionParameters` section + if you need to connect to a PostgreSQL instance without SSL - Connection to the source database must be granted with the specified user that needs to run `pg_dump` and retrieve roles information (*superuser* is OK) diff --git a/product_docs/docs/postgres_for_kubernetes/1/faq.mdx b/product_docs/docs/postgres_for_kubernetes/1/faq.mdx index 4b8788450d5..496ab3dcede 100644 --- a/product_docs/docs/postgres_for_kubernetes/1/faq.mdx +++ b/product_docs/docs/postgres_for_kubernetes/1/faq.mdx @@ -264,7 +264,7 @@ major version of Postgres is version 14, which ships out of the box: - declarative partitioning for horizontal table partitioning, which is a very well-known technique in the database area to improve vertical scalability on a single instance -- extensibility, with extensions like PostGIS for geographical +- extensibility, with extensions like [PostGIS](postgis.md) for geographical databases - parallel queries for vertical scalability - JSON support, unleashing the multi-model hybrid database for both @@ -359,7 +359,7 @@ spec: The time zone can be verified with: ```console -$ k exec -ti pg-italy-1 -c postgres -- psql -x -c "SHOW timezone" +$ kubectl exec -ti pg-italy-1 -c postgres -- psql -x -c "SHOW timezone" -[ RECORD 1 ]--------- TimeZone | Europe/Rome ``` diff --git a/product_docs/docs/postgres_for_kubernetes/1/index.mdx b/product_docs/docs/postgres_for_kubernetes/1/index.mdx index 7e2b48a1fab..27ce147edf5 100644 --- a/product_docs/docs/postgres_for_kubernetes/1/index.mdx +++ b/product_docs/docs/postgres_for_kubernetes/1/index.mdx @@ -3,70 +3,75 @@ title: EDB Postgres for Kubernetes originalFilePath: src/index.md indexCards: none navigation: -- rel_notes -- '!commercial_support.mdx' -- '!release_notes*' -- '!e2e.mdx' -- '!supported_releases.mdx' -- "#Getting Started" -- before_you_start -- use_cases -- architecture -- installation_upgrade -- quickstart -- interactive_demo -- "#Configuration" -- postgresql_conf -- operator_conf -- samples -- "#Using" -- bootstrap -- security -- database_import -- instance_manager -- scheduling -- resource_management -- failure_modes -- rolling_update -- replication -- backup_recovery -- storage -- labels_annotations -- monitoring -- logging -- certificates -- ssl_connections -- applications -- connection_pooling -- replica_cluster -- kubernetes_upgrade -- expose_pg_services -- troubleshooting -- fencing -- failover -- e2e -- container_images -- operator_capability_levels -- commercial_support -- faq -- wait_for_apply_queue -- api_reference -- "#Enhanced" -- cnp-plugin -- openshift -- evaluation -- license_keys + - rel_notes + - '!commercial_support.mdx' + - '!release_notes*' + - '!e2e.mdx' + - '!supported_releases.mdx' + - '#Getting Started' + - before_you_start + - use_cases + - architecture + - installation_upgrade + - quickstart + - interactive_demo + - '#Configuration' + - postgresql_conf + - operator_conf + - samples + - '#Using' + - bootstrap + - security + - database_import + - instance_manager + - scheduling + - resource_management + - failure_modes + - rolling_update + - replication + - backup_recovery + - storage + - labels_annotations + - monitoring + - logging + - certificates + - ssl_connections + - applications + - connection_pooling + - replica_cluster + - kubernetes_upgrade + - expose_pg_services + - troubleshooting + - fencing + - failover + - e2e + - container_images + - operator_capability_levels + - commercial_support + - faq + - wait_for_apply_queue + - api_reference + - '#Enhanced' + - cnp-plugin + - openshift + - evaluation + - license_keys + --- -The EDB Postgres for Kubernetes operator is a fork based on [CloudNativePG](https://cloudnative-pg.io). It provides additional value such as compatibility with Oracle using EDB Postgres Advanced Server and additional supported platforms such as IBM Power and OpenShift. It is designed, developed, and supported by EDB and covers the full lifecycle of a highly available Postgres database clusters with a primary/standby architecture, using native streaming replication. +EDB Postgres for Kubernetes is an operator designed, developed, and supported +by EDB that covers the full lifecycle of a highly available Postgres database +clusters with a primary/standby architecture, using native streaming +replication. -!!! Note - The operator has been renamed from Cloud Native PostgreSQL. Existing users of Cloud Native PostgreSQL will not experience any change, as the underlying components and resources have not changed. +It is based on the [open source CloudNativePG operator](https://cloudnative-pg.io), +and provides additional value such as compatibility with Oracle using EDB +Postgres Advanced Server and additional supported platforms such as IBM Power +and OpenShift. + +Key features available include: -## Key features in common with CloudNativePG - Kubernetes API integration for high availability - - CloudNativePG uses the `postgresql.cnpg.io/v1` API version - - EDB Postgres for Kubernetes uses the `postgresql.k8s.enterprisedb.io/v1` API version - Self-healing through failover and automated recreation of replicas - Capacity management with scale up/down capabilities - Planned switchovers for scheduled maintenance @@ -76,20 +81,40 @@ The EDB Postgres for Kubernetes operator is a fork based on [CloudNativePG](http - Connection Pooling with PgBouncer - Integrated metrics exporter out of the box - PostgreSQL replication across multiple Kubernetes clusters +- Red Hat certified operator for OpenShift +The operator has been renamed from Cloud Native PostgreSQL. Existing users of Cloud Native PostgreSQL will not experience any change, as the underlying components and resources have not changed. -## Features unique to EDB Postgres of Kubernetes -- Red Hat certified operator for OpenShift -- Support on IBM Power -- EDB Postgres for Kubernetes Plugin -- Oracle compatibility through EDB Postgres Advanced Sever +You can [evaluate EDB Postgres for Kubernetes for free](evaluation.md). +You need a valid license key to use EDB Postgres for Kubernetes in production. !!! Note Based on the [Operator Capability Levels model](operator_capability_levels.md), users can expect a **"Level V - Auto Pilot"** set of capabilities from the EDB Postgres for Kubernetes Operator. -## Licensing +# Differences with CloudNativePG + +The EDB Postgres for Kubernetes operator is a fork based on CloudNativePG. + +Despite both defining a custom resource called `Cluster`, they have two +different API groups. As a result, they can co-exist in the same Kubernetes +cluster. Specifically: + +- CloudNativePG uses the `postgresql.cnpg.io/v1` API version +- EDB Postgres for Kubernetes uses the `postgresql.k8s.enterprisedb.io/v1` API + version + +!!!important + Existing EDB customers with deployments of Cloud Native PostgreSQL might + have noticed that the API group for version 1 has not changed with the + introduction of EDB Postgres for Kubernetes. + +As a general rule, all features available in the open source CloudNativePG are +also available in EDB Postgres for Kubernetes - provided the correct API +version is used. + +# Licensing EDB Postgres for Kubernetes works with both PostgreSQL and EDB Postgres Advanced server, and is available under the @@ -101,7 +126,7 @@ You need a valid license key to use EDB Postgres for Kubernetes in production. ## Supported releases and Kubernetes distributions For a list of the minor releases of EDB Postgres for Kubernetes that are -supported by EDB, please refer to the ["Platform Compatibility"](https://www.enterprisedb.com/resources/platform-compatibility#pgk8s) page. +supported by EDB, please refer to the ["Supported releases"](supported_releases.md) page. Here you can also find which Kubernetes distributions and versions are supported for each of them and the EOL dates. diff --git a/product_docs/docs/postgres_for_kubernetes/1/license_keys.mdx b/product_docs/docs/postgres_for_kubernetes/1/license_keys.mdx index 4d60ecc4ef2..318646db643 100644 --- a/product_docs/docs/postgres_for_kubernetes/1/license_keys.mdx +++ b/product_docs/docs/postgres_for_kubernetes/1/license_keys.mdx @@ -1,5 +1,5 @@ --- -title: 'License and license keys' +title: 'License and License Keys' originalFilePath: 'src/license_keys.md' --- diff --git a/product_docs/docs/postgres_for_kubernetes/1/operator_capability_levels.mdx b/product_docs/docs/postgres_for_kubernetes/1/operator_capability_levels.mdx index 0bbea10e97f..71dffe165c9 100644 --- a/product_docs/docs/postgres_for_kubernetes/1/operator_capability_levels.mdx +++ b/product_docs/docs/postgres_for_kubernetes/1/operator_capability_levels.mdx @@ -230,6 +230,12 @@ connection. Import is from any supported version of Postgres and relies on `pg_dump` and `pg_restore` to be executed from the new cluster primary for all databases part of the operation and, if requested, for roles. +### PostGIS clusters + +EDB Postgres for Kubernetes supports the installation of clusters with the [PostGIS](postgis.md) +open source extension for geographical databases, one of the most popular +extensions for PostgreSQL. + ### Basic LDAP authentication for PostgreSQL The operator allows you to configure LDAP authentication for your PostgreSQL diff --git a/product_docs/docs/postgres_for_kubernetes/1/postgis.mdx b/product_docs/docs/postgres_for_kubernetes/1/postgis.mdx new file mode 100644 index 00000000000..419e33d049e --- /dev/null +++ b/product_docs/docs/postgres_for_kubernetes/1/postgis.mdx @@ -0,0 +1,155 @@ +--- +title: 'PostGIS' +originalFilePath: 'src/postgis.md' +--- + +[PostGIS](https://postgis.net/) is a very popular open source extension +for PostgreSQL that introduces support for storing GIS (Geographic Information +Systems) objects in the database and be queried via SQL. + +!!! Important + This section assumes you are familiar with PostGIS and provides some basic + information about how to create a new PostgreSQL cluster with a PostGIS database + in Kubernetes via EDB Postgres for Kubernetes. + +The CloudNativePG Community maintains container images that are built on top +of the official [PostGIS images hosted on DockerHub](https://hub.docker.com/r/postgis/postgis). +For more information please visit: + +- The [`postgis-containers` project in GitHub](https://github.com/cloudnative-pg/postgis-containers) +- The [`postgis-containers` Container Registry in GitHub](https://github.com/cloudnative-pg/postgis-containers/pkgs/container/postgis) + +Additionally, EDB provides container images for EDB Postgres Advanced Server +that include PostGIS and makes them available in the official +[registry on Quay.io](https://quay.io/repository/enterprisedb/edb-postgres-advanced?tab=tags) +with the `-postgis` suffix. + +## Basic concepts about a PostGIS cluster + +Conceptually, a PostGIS-based PostgreSQL cluster (or simply a PostGIS cluster) +is like any other PostgreSQL cluster. The only differences are: + +- the presence in the system of PostGIS and related libraries +- the presence in the database(s) of the PostGIS extension + +Since EDB Postgres for Kubernetes is based on Immutable Application Containers, the only way +to provision PostGIS is to add it to the container image that you use for the +operand. The ["Container Image Requirements" section](container_images.md) provides +detailed instructions on how this is achieved. More simply, you can just use +the PostGIS container images from the Community, as in the examples below. + +The second step is to install the extension in the PostgreSQL database. You can +do this in two ways: + +- install it in the application database, which is the main and supposedly only + database you host in the cluster according to the microservice architecture, or +- install it in the `template1` database so as to make it available for all the + databases you end up creating in the cluster, in case you adopt the monolith + architecture where the instance is shared by multiple databases + +!!! Info + For more information on the microservice vs monolith architecture in the database + please refer to the ["How many databases should be hosted in a single PostgreSQL instance?" FAQ](faq.md) + or the ["Database import" section](database_import.md). + +## Create a new PostgreSQL cluster with PostGIS + +Let's suppose you want to create a new PostgreSQL 14 cluster with PostGIS 3.2. + +The first step is to ensure you use the right PostGIS container image for the +operand, and properly set the `.spec.imageName` option in the `Cluster` +resource. + +The [`postgis-example.yaml` manifest](../samples/postgis-example.yaml) below +provides some guidance on how the creation of a PostGIS cluster can be done. + +!!! Warning + Please consider that, although convention over configuration applies in + EDB Postgres for Kubernetes, you should spend time configuring and tuning your system for + production. Also the `imageName` in the example below deliberately points + to the latest available image for PostgreSQL 14 - you should use a specific + image name or, preferably, the SHA256 digest for true immutability. + +```yaml +apiVersion: postgresql.k8s.enterprisedb.io/v1 +kind: Cluster +metadata: + name: postgis-example +spec: + instances: 3 + imageName: quay.io/enterprisedb/postgis:14 + bootstrap: + initdb: + postInitTemplateSQL: + - CREATE EXTENSION postgis; + - CREATE EXTENSION postgis_topology; + - CREATE EXTENSION fuzzystrmatch; + - CREATE EXTENSION postgis_tiger_geocoder; + + storage: + size: 1Gi +``` + +The example relies on the `postInitTemplateSQL` option which executes a list of +queries against the `template1` database, before the actual creation of the +application database (called `app`). This means that, once you have applied the +manifest and the cluster is up, you will have the above extensions installed in +both the template database and the application database, ready for use. + +!!! Info + Take some time and look at the available options in `.spec.bootstrap.initdb` + from the [API reference](api_reference.md#BootstrapInitDB), such as + `postInitApplicationSQL`. + +You can easily verify the available version of PostGIS that is in the +container, by connecting to the `app` database (you might obtain different +values from the ones in this document): + +```console +$ kubectl exec -ti postgis-example-1 -- psql app +Defaulted container "postgres" out of: postgres, bootstrap-controller (init) +psql (14.4 (Debian 14.4-1.pgdg110+1)) +Type "help" for help. + +app=# SELECT * FROM pg_available_extensions WHERE name ~ '^postgis' ORDER BY 1; + name | default_version | installed_version | comment +--------------------------+-----------------+-------------------+------------------------------------------------------------ + postgis | 3.2.2 | 3.2.2 | PostGIS geometry and geography spatial types and functions + postgis-3 | 3.2.2 | | PostGIS geometry and geography spatial types and functions + postgis_raster | 3.2.2 | | PostGIS raster types and functions + postgis_raster-3 | 3.2.2 | | PostGIS raster types and functions + postgis_sfcgal | 3.2.2 | | PostGIS SFCGAL functions + postgis_sfcgal-3 | 3.2.2 | | PostGIS SFCGAL functions + postgis_tiger_geocoder | 3.2.2 | 3.2.2 | PostGIS tiger geocoder and reverse geocoder + postgis_tiger_geocoder-3 | 3.2.2 | | PostGIS tiger geocoder and reverse geocoder + postgis_topology | 3.2.2 | 3.2.2 | PostGIS topology spatial types and functions + postgis_topology-3 | 3.2.2 | | PostGIS topology spatial types and functions +(10 rows) +``` + +The next step is to verify that the extensions listed in the +`postInitTemplateSQL` section have been correctly installed in the `app` +database. + +```console +app=# \dx + List of installed extensions + Name | Version | Schema | Description +------------------------+---------+------------+------------------------------------------------------------ + fuzzystrmatch | 1.1 | public | determine similarities and distance between strings + plpgsql | 1.0 | pg_catalog | PL/pgSQL procedural language + postgis | 3.2.2 | public | PostGIS geometry and geography spatial types and functions + postgis_tiger_geocoder | 3.2.2 | tiger | PostGIS tiger geocoder and reverse geocoder + postgis_topology | 3.2.2 | topology | PostGIS topology spatial types and functions +(5 rows) +``` + +Finally: + +```console +app=# SELECT postgis_full_version(); + postgis_full_version +---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- + POSTGIS="3.2.2 628da50" [EXTENSION] PGSQL="140" GEOS="3.9.0-CAPI-1.16.2" PROJ="7.2.1" LIBXML="2.9.10" LIBJSON="0.15" LIBPROTOBUF="1.3.3" WAGYU="0.5.0 (Internal)" TOPOLOGY +(1 row) +``` \ No newline at end of file diff --git a/product_docs/docs/postgres_for_kubernetes/1/quickstart.mdx b/product_docs/docs/postgres_for_kubernetes/1/quickstart.mdx index b418b3d1840..a96ddd576e8 100644 --- a/product_docs/docs/postgres_for_kubernetes/1/quickstart.mdx +++ b/product_docs/docs/postgres_for_kubernetes/1/quickstart.mdx @@ -84,27 +84,28 @@ kind create cluster --name pg ### CodeReady Containers (CRC) -1. [Download Red Hat CRC](https://developers.redhat.com/products/codeready-containers/overview) -and move the binary inside a directory in your `PATH`. +1. [Download Red Hat CRC](https://developers.redhat.com/products/codeready-containers/overview) + and move the binary inside a directory in your `PATH`. -1. Run the following commands: +2. Run the following commands: - ``` - crc setup - crc start - ``` + ``` + crc setup + crc start + ``` - The `crc start` output will explain how to proceed. - -1. Execute the output of the `crc oc-env` command. + The `crc start` output will explain how to proceed. + -1. Log in as `kubeadmin` with the printed `oc login` - command. You can also open the web console running `crc console`. - User and password are the same as for the `oc login` command. +3. Execute the output of the `crc oc-env` command. -1. CRC doesn't come with a StorageClass, so one has to be configured. - Follow the [Dynamic volume provisioning wiki page](https://github.com/code-ready/crc/wiki/Dynamic-volume-provisioning) - and install `rancher/local-path-provisioner`. +4. Log in as `kubeadmin` with the printed `oc login` + command. You can also open the web console running `crc console`. + User and password are the same as for the `oc login` command. + +5. CRC doesn't come with a StorageClass, so one has to be configured. + Follow the [Dynamic volume provisioning wiki page](https://github.com/code-ready/crc/wiki/Dynamic-volume-provisioning) + and install `rancher/local-path-provisioner`. ## Part 2 - Install EDB Postgres for Kubernetes diff --git a/product_docs/docs/postgres_for_kubernetes/1/samples.mdx b/product_docs/docs/postgres_for_kubernetes/1/samples.mdx index e2b0c83acb0..a75273ab44f 100644 --- a/product_docs/docs/postgres_for_kubernetes/1/samples.mdx +++ b/product_docs/docs/postgres_for_kubernetes/1/samples.mdx @@ -44,6 +44,10 @@ Full example : [`cluster-example-full.yaml`](../samples/cluster-example-full.yaml): a cluster that sets most of the available options. +PostGIS example +: [`postgis-example.yaml`](../samples/postgis-example.yaml): + an example of "PostGIS cluster" (see the [PostGIS section](postgis.md) for details.) + Replica cluster via streaming : **Prerequisites**: [`cluster-example.yaml`](../samples/cluster-example.yaml) applied and Healthy @@ -64,4 +68,8 @@ Replica cluster via backup : [`cluster-example-replica-from-backup-simple.yaml`](../samples/cluster-example-replica-from-backup-simple.yaml): a replica cluster following a cluster with backup configured. +Bootstrap cluster with SQL files +: [`cluster-example-initdb-sql-refs.yaml`](../samples/cluster-example-initdb-sql-refs.yaml): + a cluster example that will execute a set of queries defined in a Secret and a ConfigMap right after the database is created. + For a list of available options, please refer to the ["API Reference" page](api_reference.md). \ No newline at end of file diff --git a/product_docs/docs/postgres_for_kubernetes/1/samples/cluster-example-initdb-sql-refs.yaml b/product_docs/docs/postgres_for_kubernetes/1/samples/cluster-example-initdb-sql-refs.yaml new file mode 100644 index 00000000000..b853658e570 --- /dev/null +++ b/product_docs/docs/postgres_for_kubernetes/1/samples/cluster-example-initdb-sql-refs.yaml @@ -0,0 +1,47 @@ +apiVersion: v1 +kind: ConfigMap +metadata: + name: post-init-sql-configmap +data: + configmap.sql: | + create table configmaps (i integer); + insert into configmaps (select generate_series(1,10000)); +--- +apiVersion: v1 +kind: Secret +metadata: + name: post-init-sql-secret +stringData: + secret.sql: | + create table secrets (i integer); + insert into secrets (select generate_series(1,10000)); +--- +apiVersion: postgresql.k8s.enterprisedb.io/v1 +kind: Cluster +metadata: + name: cluster-example-initdb +spec: + instances: 3 + + bootstrap: + initdb: + database: appdb + owner: appuser + postInitSQL: + - create table numbers (i integer) + - insert into numbers (select generate_series(1,10000)) + postInitTemplateSQL: + - create extension intarray + postInitApplicationSQL: + - create table application_numbers (i integer) + - insert into application_numbers (select generate_series(1,10000)) + postInitApplicationSQLRefs: + configMapRefs: + - name: post-init-sql-configmap + key: configmap.sql + secretRefs: + - name: post-init-sql-secret + key: secret.sql + + storage: + size: 1Gi diff --git a/product_docs/docs/postgres_for_kubernetes/1/samples/postgis-example.yaml b/product_docs/docs/postgres_for_kubernetes/1/samples/postgis-example.yaml new file mode 100644 index 00000000000..907e4f6b378 --- /dev/null +++ b/product_docs/docs/postgres_for_kubernetes/1/samples/postgis-example.yaml @@ -0,0 +1,17 @@ +apiVersion: postgresql.k8s.enterprisedb.io/v1 +kind: Cluster +metadata: + name: postgis-example +spec: + instances: 3 + imageName: quay.io/enterprisedb/postgis:14 + bootstrap: + initdb: + postInitTemplateSQL: + - CREATE EXTENSION postgis; + - CREATE EXTENSION postgis_topology; + - CREATE EXTENSION fuzzystrmatch; + - CREATE EXTENSION postgis_tiger_geocoder; + + storage: + size: 1Gi diff --git a/product_docs/docs/postgres_for_kubernetes/1/ssl_connections.mdx b/product_docs/docs/postgres_for_kubernetes/1/ssl_connections.mdx index 3407aedfb5f..7bb51ff2019 100644 --- a/product_docs/docs/postgres_for_kubernetes/1/ssl_connections.mdx +++ b/product_docs/docs/postgres_for_kubernetes/1/ssl_connections.mdx @@ -86,7 +86,7 @@ spec: app: webtest spec: containers: - - image: quay.io/leonardoce/webtest:1.3.0 + - image: quay.io/enterprisedb/webtest:1.6.0 name: cert-test volumeMounts: - name: secret-volume-root-ca @@ -155,7 +155,7 @@ the `psql` command to connect to this service: ```shell kubectl exec -it cert-test -- bash -c "psql -'sslkey=/etc/secrets/app/tls.key sslcert=/etc/secrets/appuser/tls.crt +'sslkey=/etc/secrets/app/tls.key sslcert=/etc/secrets/app/tls.crt sslrootcert=/etc/secrets/ca/ca.crt host=cluster-example-rw.default.svc dbname=app user=app sslmode=verify-full' -c 'select version();'" ``` diff --git a/product_docs/docs/postgres_for_kubernetes/1/troubleshooting.mdx b/product_docs/docs/postgres_for_kubernetes/1/troubleshooting.mdx index 4ba6deec1b9..76e930ded46 100644 --- a/product_docs/docs/postgres_for_kubernetes/1/troubleshooting.mdx +++ b/product_docs/docs/postgres_for_kubernetes/1/troubleshooting.mdx @@ -405,6 +405,17 @@ event to occur instead of relying on the overall cluster health state. Available - LastBackupSucceeded - ContinuousArchiving +- Ready + +`LastBackupSucceeded` is reporting the status of the latest backup. If set to `True` the +last backup has been taken correctly, it is set to `False` otherwise. + +`ContinuousArchiving` is reporting the status of the WAL archiving. If set to `True` the +last WAL archival process has been terminated correctly, it is set to `False` otherwise. + +`Ready` is `True` when the cluster has the number of instances specified by the user +and the primary instance is ready. This condition can be used in scripts to wait for +the cluster to be created. ### How to wait for a particular condition @@ -420,6 +431,12 @@ $ kubectl wait --for=condition=LastBackupSucceeded cluster/ -n -n ``` +- Ready (Cluster is ready or not): + +```bash +$ kubectl wait --for=condition=Ready cluster/ -n +``` + Below is a snippet of a `cluster.status` that contains a failing condition. ```bash @@ -431,14 +448,21 @@ $ kubectl get cluster/ -o yaml conditions: - message: 'unexpected failure invoking barman-cloud-wal-archive: exit status 2' - reason: Continuous Archiving is Failing + reason: ContinuousArchivingFailing status: "False" type: ContinuousArchiving - message: exit status 2 - reason: Backup is failed + reason: LastBackupFailed status: "False" type: LastBackupSucceeded + + - message: Cluster Is Not Ready + reason: ClusterIsNotReady + status: "False" + type: Ready + + ``` ## Some common issues From be65e7cc0dd8ae990768ce9279175eb421558414 Mon Sep 17 00:00:00 2001 From: Josh Heyer Date: Wed, 10 Aug 2022 21:21:46 +0000 Subject: [PATCH 16/16] retain index changes, exclude postInitApplicationSQLRefs from update --- .../1/api_reference.mdx | 52 +++++++------------ .../postgres_for_kubernetes/1/bootstrap.mdx | 33 ------------ .../docs/postgres_for_kubernetes/1/index.mdx | 50 +++++------------- .../1/license_keys.mdx | 2 +- .../postgres_for_kubernetes/1/samples.mdx | 4 -- 5 files changed, 33 insertions(+), 108 deletions(-) diff --git a/product_docs/docs/postgres_for_kubernetes/1/api_reference.mdx b/product_docs/docs/postgres_for_kubernetes/1/api_reference.mdx index f8b709a594a..c5772930db9 100644 --- a/product_docs/docs/postgres_for_kubernetes/1/api_reference.mdx +++ b/product_docs/docs/postgres_for_kubernetes/1/api_reference.mdx @@ -69,7 +69,6 @@ Below you will find a description of the defined resources: - [PoolerSecrets](#PoolerSecrets) - [PoolerSpec](#PoolerSpec) - [PoolerStatus](#PoolerStatus) -- [PostInitApplicationSQLRefs](#PostInitApplicationSQLRefs) - [PostgresConfiguration](#PostgresConfiguration) - [RecoveryTarget](#RecoveryTarget) - [ReplicaClusterConfiguration](#ReplicaClusterConfiguration) @@ -209,9 +208,9 @@ BarmanCredentials an object containing the potential credentials for each cloud | Name | Description | Type | | ------------------- | ------------------------------------------------------------- | ----------------------------------------- | -| `googleCredentials` | The credentials to use to upload data to Google Cloud Storage | [\*GoogleCredentials](#GoogleCredentials) | -| `s3Credentials ` | The credentials to use to upload data to S3 | [\*S3Credentials](#S3Credentials) | -| `azureCredentials ` | The credentials to use to upload data to Azure Blob Storage | [\*AzureCredentials](#AzureCredentials) | +| `googleCredentials` | The credentials to use to upload data to S3 | [\*GoogleCredentials](#GoogleCredentials) | +| `s3Credentials ` | The credentials to use to upload data to Azure Blob Storage | [\*S3Credentials](#S3Credentials) | +| `azureCredentials ` | The credentials to use to upload data to Google Cloud Storage | [\*AzureCredentials](#AzureCredentials) | @@ -248,23 +247,22 @@ BootstrapConfiguration contains information about how to create the PostgreSQL c BootstrapInitDB is the configuration of the bootstrap process when initdb is used Refer to the Bootstrap page of the documentation for more information. -| Name | Description | Type | -| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | -| `database ` | Name of the database used by the application. Default: `app`. - *mandatory* | string | -| `owner ` | Name of the owner of the database in the instance to be used by applications. Defaults to the value of the `database` key. - *mandatory* | string | -| `secret ` | Name of the secret containing the initial credentials for the owner of the user database. If empty a new secret will be created from scratch | [\*LocalObjectReference](#LocalObjectReference) | -| `redwood ` | If we need to enable/disable Redwood compatibility. Requires EPAS and for EPAS defaults to true | \*bool | -| `options ` | The list of options that must be passed to initdb when creating the cluster. Deprecated: This could lead to inconsistent configurations, please use the explicit provided parameters instead. If defined, explicit values will be ignored. | \[]string | -| `dataChecksums ` | Whether the `-k` option should be passed to initdb, enabling checksums on data pages (default: `false`) | \*bool | -| `encoding ` | The value to be passed as option `--encoding` for initdb (default:`UTF8`) | string | -| `localeCollate ` | The value to be passed as option `--lc-collate` for initdb (default:`C`) | string | -| `localeCType ` | The value to be passed as option `--lc-ctype` for initdb (default:`C`) | string | -| `walSegmentSize ` | The value in megabytes (1 to 1024) to be passed to the `--wal-segsize` option for initdb (default: empty, resulting in PostgreSQL default: 16MB) | int | -| `postInitSQL ` | List of SQL queries to be executed as a superuser immediately after the cluster has been created - to be used with extreme care (by default empty) | \[]string | -| `postInitApplicationSQL ` | List of SQL queries to be executed as a superuser in the application database right after is created - to be used with extreme care (by default empty) | \[]string | -| `postInitTemplateSQL ` | List of SQL queries to be executed as a superuser in the `template1` after the cluster has been created - to be used with extreme care (by default empty) | \[]string | -| `import ` | Bootstraps the new cluster by importing data from an existing PostgreSQL instance using logical backup (`pg_dump` and `pg_restore`) | [\*Import](#Import) | -| `postInitApplicationSQLRefs` | PostInitApplicationSQLRefs points references to ConfigMaps or Secrets which contain SQL files, the general implementation order to these references is from all Secrets to all ConfigMaps, and inside Secrets or ConfigMaps, the implementation order is same as the order of each array (by default empty) | [\*PostInitApplicationSQLRefs](#PostInitApplicationSQLRefs) | +| Name | Description | Type | +| ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- | +| `database ` | Name of the database used by the application. Default: `app`. - *mandatory* | string | +| `owner ` | Name of the owner of the database in the instance to be used by applications. Defaults to the value of the `database` key. - *mandatory* | string | +| `secret ` | Name of the secret containing the initial credentials for the owner of the user database. If empty a new secret will be created from scratch | [\*LocalObjectReference](#LocalObjectReference) | +| `redwood ` | If we need to enable/disable Redwood compatibility. Requires EPAS and for EPAS defaults to true | \*bool | +| `options ` | The list of options that must be passed to initdb when creating the cluster. Deprecated: This could lead to inconsistent configurations, please use the explicit provided parameters instead. If defined, explicit values will be ignored. | \[]string | +| `dataChecksums ` | Whether the `-k` option should be passed to initdb, enabling checksums on data pages (default: `false`) | \*bool | +| `encoding ` | The value to be passed as option `--encoding` for initdb (default:`UTF8`) | string | +| `localeCollate ` | The value to be passed as option `--lc-collate` for initdb (default:`C`) | string | +| `localeCType ` | The value to be passed as option `--lc-ctype` for initdb (default:`C`) | string | +| `walSegmentSize ` | The value in megabytes (1 to 1024) to be passed to the `--wal-segsize` option for initdb (default: empty, resulting in PostgreSQL default: 16MB) | int | +| `postInitSQL ` | List of SQL queries to be executed as a superuser immediately after the cluster has been created - to be used with extreme care (by default empty) | \[]string | +| `postInitApplicationSQL` | List of SQL queries to be executed as a superuser in the application database right after is created - to be used with extreme care (by default empty) | \[]string | +| `postInitTemplateSQL ` | List of SQL queries to be executed as a superuser in the `template1` after the cluster has been created - to be used with extreme care (by default empty) | \[]string | +| `import ` | Bootstraps the new cluster by importing data from an existing PostgreSQL instance using logical backup (`pg_dump` and `pg_restore`) | [\*Import](#Import) | @@ -404,7 +402,6 @@ ClusterStatus defines the observed state of Cluster | `resizingPVC ` | List of all the PVCs that have ResizingPVC condition. | \[]string | | `initializingPVC ` | List of all the PVCs that are being initialized by this cluster | \[]string | | `healthyPVC ` | List of all the PVCs not dangling nor initializing | \[]string | -| `licenseStatus ` | Status of the license | licensekey.Status | | `writeService ` | Current write pod | string | | `readService ` | Current list of read pods | string | | `phase ` | Current phase of the cluster | string | @@ -756,17 +753,6 @@ PoolerStatus defines the observed state of Pooler | `secrets ` | The resource version of the config object | [\*PoolerSecrets](#PoolerSecrets) | | `instances` | The number of pods trying to be scheduled | int32 | - - -## PostInitApplicationSQLRefs - -PostInitApplicationSQLRefs points references to ConfigMaps or Secrets which contain SQL files, the general implementation order to these references is from all Secrets to all ConfigMaps, and inside Secrets or ConfigMaps, the implementation order is same as the order of each array - -| Name | Description | Type | -| --------------- | ------------------------------------------------------ | ------------------------------------------------- | -| `secretRefs ` | SecretRefs holds a list of references to Secrets | [\[\]SecretKeySelector](#SecretKeySelector) | -| `configMapRefs` | ConfigMapRefs holds a list of references to ConfigMaps | [\[\]ConfigMapKeySelector](#ConfigMapKeySelector) | - ## PostgresConfiguration diff --git a/product_docs/docs/postgres_for_kubernetes/1/bootstrap.mdx b/product_docs/docs/postgres_for_kubernetes/1/bootstrap.mdx index 7375b8b5315..b3579c6853e 100644 --- a/product_docs/docs/postgres_for_kubernetes/1/bootstrap.mdx +++ b/product_docs/docs/postgres_for_kubernetes/1/bootstrap.mdx @@ -283,39 +283,6 @@ spec: as queries are run as a superuser and can disrupt the entire cluster. An error in any of those queries interrupts the bootstrap phase, leaving the cluster incomplete. -Moreover, you can specify a list of Secrets and/or ConfigMaps which contains SQL script that will be executed after the database is created and configured. These SQL script will be executed using the **superuser** role (`postgres`), connected to the database specified in the `initdb` section: - -```yaml -apiVersion: postgresql.k8s.enterprisedb.io/v1 -kind: Cluster -metadata: - name: cluster-example-initdb -spec: - instances: 3 - - bootstrap: - initdb: - database: app - owner: app - postInitApplicationSQLRefs: - secretRefs: - - name: my-secret - key: secret.sql - configMapRefs: - - name: my-configmap - key: configmap.sql - storage: - size: 1Gi -``` - -!!! Note - The SQL scripts referenced in `secretRefs` will be executed before the ones referenced in `configMapRefs`. For both sections the SQL scripts will be executed respecting the order in the list. - Inside SQL scripts, each SQL statement is executed in a single exec on the server according to the [PostgreSQL semantics](https://www.postgresql.org/docs/current/protocol-flow.html#PROTOCOL-FLOW-MULTI-STATEMENT), comments can be included, but internal command like `psql` cannot. - -!!! Warning - Please make sure the existence of the entries inside the ConfigMaps or Secrets specified in `postInitApplicationSQLRefs`, otherwise the bootstrap will fail. - Errors in any of those SQL files will prevent the bootstrap phase to complete successfully. - ### Compatibility Features EDB Postgres Advanced adds many compatibility features to the diff --git a/product_docs/docs/postgres_for_kubernetes/1/index.mdx b/product_docs/docs/postgres_for_kubernetes/1/index.mdx index 27ce147edf5..b46acd476df 100644 --- a/product_docs/docs/postgres_for_kubernetes/1/index.mdx +++ b/product_docs/docs/postgres_for_kubernetes/1/index.mdx @@ -59,19 +59,15 @@ navigation: --- -EDB Postgres for Kubernetes is an operator designed, developed, and supported -by EDB that covers the full lifecycle of a highly available Postgres database -clusters with a primary/standby architecture, using native streaming -replication. +The EDB Postgres for Kubernetes operator is a fork based on [CloudNativePG](https://cloudnative-pg.io). It provides additional value such as compatibility with Oracle using EDB Postgres Advanced Server and additional supported platforms such as IBM Power and OpenShift. It is designed, developed, and supported by EDB and covers the full lifecycle of a highly available Postgres database clusters with a primary/standby architecture, using native streaming replication. -It is based on the [open source CloudNativePG operator](https://cloudnative-pg.io), -and provides additional value such as compatibility with Oracle using EDB -Postgres Advanced Server and additional supported platforms such as IBM Power -and OpenShift. - -Key features available include: +!!! Note + The operator has been renamed from Cloud Native PostgreSQL. Existing users of Cloud Native PostgreSQL will not experience any change, as the underlying components and resources have not changed. +## Key features in common with CloudNativePG - Kubernetes API integration for high availability + - CloudNativePG uses the `postgresql.cnpg.io/v1` API version + - EDB Postgres for Kubernetes uses the `postgresql.k8s.enterprisedb.io/v1` API version - Self-healing through failover and automated recreation of replicas - Capacity management with scale up/down capabilities - Planned switchovers for scheduled maintenance @@ -81,40 +77,20 @@ Key features available include: - Connection Pooling with PgBouncer - Integrated metrics exporter out of the box - PostgreSQL replication across multiple Kubernetes clusters -- Red Hat certified operator for OpenShift -The operator has been renamed from Cloud Native PostgreSQL. Existing users of Cloud Native PostgreSQL will not experience any change, as the underlying components and resources have not changed. -You can [evaluate EDB Postgres for Kubernetes for free](evaluation.md). -You need a valid license key to use EDB Postgres for Kubernetes in production. +## Features unique to EDB Postgres of Kubernetes +- Red Hat certified operator for OpenShift +- Support on IBM Power +- EDB Postgres for Kubernetes Plugin +- Oracle compatibility through EDB Postgres Advanced Sever !!! Note Based on the [Operator Capability Levels model](operator_capability_levels.md), users can expect a **"Level V - Auto Pilot"** set of capabilities from the EDB Postgres for Kubernetes Operator. -# Differences with CloudNativePG - -The EDB Postgres for Kubernetes operator is a fork based on CloudNativePG. - -Despite both defining a custom resource called `Cluster`, they have two -different API groups. As a result, they can co-exist in the same Kubernetes -cluster. Specifically: - -- CloudNativePG uses the `postgresql.cnpg.io/v1` API version -- EDB Postgres for Kubernetes uses the `postgresql.k8s.enterprisedb.io/v1` API - version - -!!!important - Existing EDB customers with deployments of Cloud Native PostgreSQL might - have noticed that the API group for version 1 has not changed with the - introduction of EDB Postgres for Kubernetes. - -As a general rule, all features available in the open source CloudNativePG are -also available in EDB Postgres for Kubernetes - provided the correct API -version is used. - -# Licensing +## Licensing EDB Postgres for Kubernetes works with both PostgreSQL and EDB Postgres Advanced server, and is available under the @@ -126,7 +102,7 @@ You need a valid license key to use EDB Postgres for Kubernetes in production. ## Supported releases and Kubernetes distributions For a list of the minor releases of EDB Postgres for Kubernetes that are -supported by EDB, please refer to the ["Supported releases"](supported_releases.md) page. +supported by EDB, please refer to the ["Platform Compatibility"](https://www.enterprisedb.com/resources/platform-compatibility#pgk8s) page. Here you can also find which Kubernetes distributions and versions are supported for each of them and the EOL dates. diff --git a/product_docs/docs/postgres_for_kubernetes/1/license_keys.mdx b/product_docs/docs/postgres_for_kubernetes/1/license_keys.mdx index 318646db643..4d60ecc4ef2 100644 --- a/product_docs/docs/postgres_for_kubernetes/1/license_keys.mdx +++ b/product_docs/docs/postgres_for_kubernetes/1/license_keys.mdx @@ -1,5 +1,5 @@ --- -title: 'License and License Keys' +title: 'License and license keys' originalFilePath: 'src/license_keys.md' --- diff --git a/product_docs/docs/postgres_for_kubernetes/1/samples.mdx b/product_docs/docs/postgres_for_kubernetes/1/samples.mdx index a75273ab44f..3892375c90e 100644 --- a/product_docs/docs/postgres_for_kubernetes/1/samples.mdx +++ b/product_docs/docs/postgres_for_kubernetes/1/samples.mdx @@ -68,8 +68,4 @@ Replica cluster via backup : [`cluster-example-replica-from-backup-simple.yaml`](../samples/cluster-example-replica-from-backup-simple.yaml): a replica cluster following a cluster with backup configured. -Bootstrap cluster with SQL files -: [`cluster-example-initdb-sql-refs.yaml`](../samples/cluster-example-initdb-sql-refs.yaml): - a cluster example that will execute a set of queries defined in a Secret and a ConfigMap right after the database is created. - For a list of available options, please refer to the ["API Reference" page](api_reference.md). \ No newline at end of file