Merge pull request #2520 from EnterpriseDB/docs/mtk/adding-arch-insta…

…ll-hieracrchy Install template: consolidated install topics model
EnterpriseDB · Apr 8, 2022 · dcb6fb9 · dcb6fb9
2 parents d4450a3 + 2fbb9cf
commit dcb6fb9
Show file tree

Hide file tree

Showing 40 changed files with 332 additions and 220 deletions.
diff --git a/product_docs/docs/efm/4/03_installing_efm/13_initial_config.mdx b/product_docs/docs/efm/4/03_installing_efm/13_initial_config.mdx
diff --git a/...03_installing_efm/09_efm4_rhel8_ppcle.mdx → ...ibm_power_pcc64le/09_efm4_rhel8_ppcle.mdx b/...03_installing_efm/09_efm4_rhel8_ppcle.mdx → ...ibm_power_pcc64le/09_efm4_rhel8_ppcle.mdx
@@ -1,11 +1,13 @@
 ---
-title: "RHEL 8 on IBM Power (ppc64le)"
+title: "Installing Failover Manager on RHEL 8 IBM Power (ppc64le)"
+navTitle: "RHEL 8 "
 ---
 
-There are two steps to completing an installation:
+There are three steps to completing an installation:
 
 - Setting up the repository
 - Installing the package
+- Initial configuration
 
 For each step, you must be logged in as superuser.
 
@@ -15,7 +17,7 @@ To log in as a superuser:
 sudo su -
 ```
 
-#### Setting up the Repository
+## 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).
 
@@ -55,10 +57,21 @@ sudo su -
    dnf -qy module disable postgresql
    ```
 
-#### Installing the Package
+## Installing the package
 
 ```shell
 dnf -y install edb-efm<xx>
 ```
 where `<xx>` is the version number of Failover Manager.
 
+## Initial configuration
+
+If you are using Failover Manager to monitor a cluster owned by a user other than enterprisedb or postgres, see [Extending Failover Manager permissions](../../04_configuring_efm/04_extending_efm_permissions/#extending_efm_permissions).
+
+After installing on each node of the cluster:
+
+1.  Modify the [cluster properties file](../../04_configuring_efm/01_cluster_properties/#cluster_properties) on each node.
+2.  Modify the [cluster members file](../../04_configuring_efm/03_cluster_members/#cluster_members) on each node.
+3.  If applicable, configure and test virtual IP address settings and any scripts that are identified in the cluster properties file.
+4.  Start the agent on each node of the cluster. For more information, see [Controlling the Failover Manager service](../../08_controlling_efm_service/#controlling-the-failover-manager-service).
+
diff --git a/...03_installing_efm/10_efm4_rhel7_ppcle.mdx → ...ibm_power_pcc64le/10_efm4_rhel7_ppcle.mdx b/...03_installing_efm/10_efm4_rhel7_ppcle.mdx → ...ibm_power_pcc64le/10_efm4_rhel7_ppcle.mdx
@@ -1,5 +1,6 @@
 ---
-title: "RHEL 7 on IBM Power (ppc64le)"
+title: "Installing Failover Manager on RHEL 7 IBM Power (ppc64le)"
+navTitle: "RHEL 7"
 ---
 
 To request credentials that allow you to access an EnterpriseDB repository, see the [EDB Repository Access instructions](https://info.enterprisedb.com/rs/069-ALB-339/images/Repository%20Access%2004-09-2019.pdf).
@@ -54,3 +55,13 @@ To request credentials that allow you to access an EnterpriseDB repository, see
     ```text
     yum -y install edb-efm42
     ```
+## Initial configuration
+
+If you are using Failover Manager to monitor a cluster owned by a user other than enterprisedb or postgres, see [Extending Failover Manager permissions](../../04_configuring_efm/04_extending_efm_permissions/#extending_efm_permissions).
+
+After installing on each node of the cluster:
+
+1.  Modify the [cluster properties file](../../04_configuring_efm/01_cluster_properties/#cluster_properties) on each node.
+2.  Modify the [cluster members file](../../04_configuring_efm/03_cluster_members/#cluster_members) on each node.
+3.  If applicable, configure and test virtual IP address settings and any scripts that are identified in the cluster properties file.
+4.  Start the agent on each node of the cluster. For more information, see [Controlling the Failover Manager service](../../08_controlling_efm_service/#controlling-the-failover-manager-service).
diff --git a/...3_installing_efm/11_efm4_sles15_ppcle.mdx → ...bm_power_pcc64le/11_efm4_sles15_ppcle.mdx b/...3_installing_efm/11_efm4_sles15_ppcle.mdx → ...bm_power_pcc64le/11_efm4_sles15_ppcle.mdx
@@ -1,13 +1,14 @@
 ---
-title: "SLES 15 on IBM Power (ppc64le)"
+title: "Installing Failover Manager on SLES 15 IBM Power (ppc64le)"
+navTitle: "SLES 15"
 ---
 
 
 There are three steps to completing an installation:
 
 - [Setting up the repository](#setting-up-the-repository)
 - [Installing the package](#installing-the-package)
-- [Performing the initial configuration](12_initial_config)
+- [Performing the initial configuration](#initial-configuration)
 
 For each step, you must be logged in as superuser.
 
@@ -18,7 +19,7 @@ sudo su -
 
 Before setting up the repository, you need to register with EDB. To receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request).
 
-## Setting 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 these steps.
 
@@ -43,11 +44,21 @@ SUSEConnect -p PackageHub/15.3/ppc64le
 zypper refresh
 ```
 
-## Installing the Package
+## Installing the package
 
 ```shell
 zypper -n install edb-efmedb-efm<4x>
 ```
 
 Where <4x> is the version of Failover Manager you are installing.
 
+## Initial configuration
+
+If you are using Failover Manager to monitor a cluster owned by a user other than enterprisedb or postgres, see [Extending Failover Manager permissions](04_configuring_efm/04_extending_efm_permissions/#extending_efm_permissions).
+
+After installing on each node of the cluster:
+
+1.  Modify the [cluster properties file](../../04_configuring_efm/01_cluster_properties/#cluster_properties) on each node.
+2.  Modify the [cluster members file](../../04_configuring_efm/03_cluster_members/#cluster_members) on each node.
+3.  If applicable, configure and test virtual IP address settings and any scripts that are identified in the cluster properties file.
+4.  Start the agent on each node of the cluster. For more information, see [Controlling the Failover Manager service](../../08_controlling_efm_service/#controlling-the-failover-manager-service).
diff --git a/...3_installing_efm/12_efm4_sles12_ppcle.mdx → ...bm_power_pcc64le/12_efm4_sles12_ppcle.mdx b/...3_installing_efm/12_efm4_sles12_ppcle.mdx → ...bm_power_pcc64le/12_efm4_sles12_ppcle.mdx
@@ -1,11 +1,13 @@
 ---
-title: "SLES 12 on IBM Power (ppc64le)"
+title: "Installing Failover Manager on SLES 12 IBM Power (ppc64le)"
+navTitle: "SLES 12"
 ---
 
 There are two steps to completing an installation:
 
 - [Setting up the repository](#setting-up-the-repository)
 - [Installing the package](#installing-the-package)
+- [Initial configuration](#initial-configuration)
 
 
 For each step, you must be logged in as superuser.
@@ -51,3 +53,13 @@ zypper -n install edb-efm<4x>
 
 Where <4x> is the version of Failover Manager you are installing.
 
+## Initial configuration
+
+If you are using Failover Manager to monitor a cluster owned by a user other than enterprisedb or postgres, see [Extending Failover Manager permissions](../../04_configuring_efm/04_extending_efm_permissions/#extending_efm_permissions).
+
+After installing on each node of the cluster:
+
+1.  Modify the [cluster properties file](../../04_configuring_efm/01_cluster_properties/#cluster_properties) on each node.
+2.  Modify the [cluster members file](../../04_configuring_efm/03_cluster_members/#cluster_members) on each node.
+3.  If applicable, configure and test virtual IP address settings and any scripts that are identified in the cluster properties file.
+4.  Start the agent on each node of the cluster. For more information, see [Controlling the Failover Manager service](../../08_controlling_efm_service/#controlling-the-failover-manager-service).
diff --git a/product_docs/docs/efm/4/03_installing_efm/ibm_power_pcc64le/index.mdx b/product_docs/docs/efm/4/03_installing_efm/ibm_power_pcc64le/index.mdx
@@ -0,0 +1,16 @@
+---
+title: "Installing Failover Manager on IBM Power (ppc64le)"
+navTitle: "IBM Power (ppc64le)"
+---
+
+<div id="installing_efm" class="registered_link"></div>
+
+<div id="linux_installation" class="registered_link"></div>
+
+For operating system-specific install instructions, including accessing the repo, see:
+
+  - [RHEL 8](09_efm4_rhel8_ppcle)
+
+  - [RHEL 7](10_efm4_rhel7_ppcle)
+  - [SLES 15](11_efm4_sles15_ppcle)
+  - [SLES 12](12_efm4_sles12_ppcle)
diff --git a/product_docs/docs/efm/4/03_installing_efm/index.mdx b/product_docs/docs/efm/4/03_installing_efm/index.mdx
@@ -1,17 +1,25 @@
 ---
-title: "Installing Failover Manager"
+title: "Installing Failover Manager on Linux"
+navTitle: "Installing on Linux"
 redirects:
  - ../efm_user/03_installing_efm
 legacyRedirectsGenerated:
   # This list is generated by a script. If you need add entries, use the `legacyRedirects` key.
   - "/edb-docs/d/edb-postgres-failover-manager/user-guides/user-guide/4.0/installing_efm.html"
   - "/edb-docs/d/edb-postgres-failover-manager/user-guides/user-guide/4.1/installing_efm.html"
+navigation:
+- x86_amd64
+- ibm_power_pcc64le
+- 13_initial_config
+- 14_install_details
 ---
 
 <div id="installing_efm" class="registered_link"></div>
 
 <div id="linux_installation" class="registered_link"></div>
 
+Native packages for Linux are available in the EDB repository.
+
 For information about the platforms and versions supported by Failover Manager, see [Platform Compatibility](https://www.enterprisedb.com/platform-compatibility#efm).
 
 !!! Note
@@ -21,21 +29,20 @@ For information about the platforms and versions supported by Failover Manager,
 For platform-specific install instructions, including accessing the repo, see:
 
 - Linux x86-64 (amd64):
-  - [RHEL 8/OL 8](01_efm4_rhel_8_x86)
+  - [RHEL 8/OL 8](x86_amd64/01_efm4_rhel_8_x86)
 
-  - [Rocky Linux 8/AlmaLinux 8](02_efm4_other_linux8_x86)
-  - [RHEL 7/OL 7](03_efm4_rhel7_x86)
-  - [CentOS 7](04_efm4_centos7_x86)
-  - [SLES 15](05_efm4_sles15_x86)
-  - [SLES 12](06_efm4_sles12_x86)
-  - [Ubuntu 20.04/Debian 10](07_efm4_ubuntu20_deb10_x8)
-  - [Ubuntu 18.04/Debian 9](08_efm4_ubuntu18_deb9_x86)
+  - [Rocky Linux 8/AlmaLinux 8](x86_amd64/02_efm4_other_linux8_x86)
+  - [RHEL 7/OL 7](x86_amd64/03_efm4_rhel7_x86)
+  - [CentOS 7](x86_amd64/04_efm4_centos7_x86)
+  - [SLES 15](x86_amd64/05_efm4_sles15_x86)
+  - [SLES 12](x86_amd64/06_efm4_sles12_x86)
+  - [Ubuntu 20.04/Debian 10](x86_amd64/07_efm4_ubuntu20_deb10_x8)
+  - [Ubuntu 18.04/Debian 9](x86_amd64/08_efm4_ubuntu18_deb9_x86)
 
 - Linux on IBM Power (ppc64le):
-  - [RHEL 8](09_efm4_rhel8_ppcle)
+  - [RHEL 8](ibm_power_pcc64le/09_efm4_rhel8_ppcle)
 
-  - [RHEL 7](10_efm4_rhel7_ppcle)
-  - [SLES 15](11_efm4_sles15_ppcle)
-  - [SLES 12](12_efm4_sles12_ppcle)
+  - [RHEL 7](ibm_power_pcc64le/10_efm4_rhel7_ppcle)
+  - [SLES 15](ibm_power_pcc64le/11_efm4_sles15_ppcle)
+  - [SLES 12](ibm_power_pcc64le/12_efm4_sles12_ppcle)
 
-After you complete the installation, see [Initial configuration](13_initial_config).
diff --git a/.../03_installing_efm/01_efm4_rhel_8_x86.mdx → ...ling_efm/x86_amd64/01_efm4_rhel_8_x86.mdx b/.../03_installing_efm/01_efm4_rhel_8_x86.mdx → ...ling_efm/x86_amd64/01_efm4_rhel_8_x86.mdx
@@ -1,5 +1,6 @@
 ---
-title: "RHEL 8/OL 8 on x86_64"
+title: "Installing Failover Manager on RHEL 8/OL 8 x86"
+navTitle: "RHEL 8/OL 8"
 ---
 
 To request credentials that allow you to access an EnterpriseDB repository, see the [EDB Repository Access instructions](https://info.enterprisedb.com/rs/069-ALB-339/images/Repository%20Access%2004-09-2019.pdf).
@@ -47,4 +48,13 @@ After receiving your credentials, you must create the EnterpriseDB repository co
     dnf -y install edb-efm42
     ```
 
+## Initial configuration
 
+If you are using Failover Manager to monitor a cluster owned by a user other than enterprisedb or postgres, see [Extending Failover Manager permissions](../../04_configuring_efm/04_extending_efm_permissions/#extending_efm_permissions).
+
+After installing on each node of the cluster:
+
+1.  Modify the [cluster properties file](../../04_configuring_efm/01_cluster_properties/#cluster_properties) on each node.
+2.  Modify the [cluster members file](../../04_configuring_efm/03_cluster_members/#cluster_members) on each node.
+3.  If applicable, configure and test virtual IP address settings and any scripts that are identified in the cluster properties file.
+4.  Start the agent on each node of the cluster. For more information, see [Controlling the Failover Manager service](../../08_controlling_efm_service/#controlling-the-failover-manager-service).
diff --git a/...stalling_efm/02_efm4_other_linux8_x86.mdx → ...fm/x86_amd64/02_efm4_other_linux8_x86.mdx b/...stalling_efm/02_efm4_other_linux8_x86.mdx → ...fm/x86_amd64/02_efm4_other_linux8_x86.mdx
@@ -1,5 +1,6 @@
 ---
-title: "Rocky Linux 8/AlmaLinux 8 on x86_64"
+title: "Installing Failover Manager on Rocky Linux 8/AlmaLinux 8 x86"
+navTitle: "Rocky Linux 8/AlmaLinux 8"
 ---
 
 To request credentials that allow you to access an EnterpriseDB repository, see the [EDB Repository Access instructions](https://info.enterprisedb.com/rs/069-ALB-339/images/Repository%20Access%2004-09-2019.pdf).
@@ -46,4 +47,13 @@ After receiving your credentials, you must create the EnterpriseDB repository co
     dnf -y install edb-efm42
     ```
 
+## Initial configuration
 
+If you are using Failover Manager to monitor a cluster owned by a user other than enterprisedb or postgres, see [Extending Failover Manager permissions](../../04_configuring_efm/04_extending_efm_permissions/#extending_efm_permissions).
+
+After installing on each node of the cluster:
+
+1.  Modify the [cluster properties file](../../04_configuring_efm/01_cluster_properties/#cluster_properties) on each node.
+2.  Modify the [cluster members file](../../04_configuring_efm/03_cluster_members/#cluster_members) on each node.
+3.  If applicable, configure and test virtual IP address settings and any scripts that are identified in the cluster properties file.
+4.  Start the agent on each node of the cluster. For more information, see [Controlling the Failover Manager service](../../08_controlling_efm_service/#controlling-the-failover-manager-service).
diff --git a/...4/03_installing_efm/03_efm4_rhel7_x86.mdx → ...lling_efm/x86_amd64/03_efm4_rhel7_x86.mdx b/...4/03_installing_efm/03_efm4_rhel7_x86.mdx → ...lling_efm/x86_amd64/03_efm4_rhel7_x86.mdx
@@ -1,5 +1,6 @@
 ---
-title: "RHEL 7/OL 7 on x86_64"
+title: "Installing Failover Manager on RHEL 7/OL 7 x86"
+navTitle: "RHEL 7/OL 7"
 ---
 
 To request credentials that allow you to access an EnterpriseDB repository, see the [EDB Repository Access instructions](https://info.enterprisedb.com/rs/069-ALB-339/images/Repository%20Access%2004-09-2019.pdf).
@@ -45,3 +46,13 @@ After receiving your credentials, you must create the EnterpriseDB repository co
     yum -y install edb-efm42
     ```
 
+## Initial configuration
+
+If you are using Failover Manager to monitor a cluster owned by a user other than enterprisedb or postgres, see [Extending Failover Manager permissions](../../04_configuring_efm/04_extending_efm_permissions/#extending_efm_permissions).
+
+After installing on each node of the cluster:
+
+1.  Modify the [cluster properties file](../../04_configuring_efm/01_cluster_properties/#cluster_properties) on each node.
+2.  Modify the [cluster members file](../../04_configuring_efm/03_cluster_members/#cluster_members) on each node.
+3.  If applicable, configure and test virtual IP address settings and any scripts that are identified in the cluster properties file.
+4.  Start the agent on each node of the cluster. For more information, see [Controlling the Failover Manager service](../../08_controlling_efm_service/#controlling-the-failover-manager-service).
diff --git a/...03_installing_efm/04_efm4_centos7_x86.mdx → ...ing_efm/x86_amd64/04_efm4_centos7_x86.mdx b/...03_installing_efm/04_efm4_centos7_x86.mdx → ...ing_efm/x86_amd64/04_efm4_centos7_x86.mdx
@@ -1,5 +1,6 @@
 ---
-title: "CentOS 7 on x86_64"
+title: "Installing Failover Manager on CentOS 7 x86"
+navTitle: "CentOS 7"
 ---
 
 To request credentials that allow you to access an EnterpriseDB repository, see the [EDB Repository Access instructions](https://info.enterprisedb.com/rs/069-ALB-339/images/Repository%20Access%2004-09-2019.pdf).
@@ -39,3 +40,13 @@ After receiving your credentials, you must create the EnterpriseDB repository co
     yum -y install edb-efm42
     ```
 
+## Initial configuration
+
+If you are using Failover Manager to monitor a cluster owned by a user other than enterprisedb or postgres, see [Extending Failover Manager permissions](04_configuring_efm/04_extending_efm_permissions/#extending_efm_permissions).
+
+After installing on each node of the cluster:
+
+1.  Modify the [cluster properties file](../../04_configuring_efm/01_cluster_properties/#cluster_properties) on each node.
+2.  Modify the [cluster members file](../../04_configuring_efm/03_cluster_members/#cluster_members) on each node.
+3.  If applicable, configure and test virtual IP address settings and any scripts that are identified in the cluster properties file.
+4.  Start the agent on each node of the cluster. For more information, see [Controlling the Failover Manager service](../../08_controlling_efm_service/#controlling-the-failover-manager-service).
diff --git a/.../03_installing_efm/05_efm4_sles15_x86.mdx → ...ling_efm/x86_amd64/05_efm4_sles15_x86.mdx b/.../03_installing_efm/05_efm4_sles15_x86.mdx → ...ling_efm/x86_amd64/05_efm4_sles15_x86.mdx
@@ -1,12 +1,13 @@
 ---
-title: "SLES 15 on x86_64"
+title: "Installing Failover Manager on SLES 15 x86"
+navTitle: "SLES 15"
 ---
 
 There are three steps to completing an installation:
 
 - [Setting up the repository](#setting-up-the-repository)
 - [Installing the package](#installing-the-package)
-- [Performing the initial configuration](12_initial_config)
+- [Performing the initial configuration](#initial-configuration)
 
 For each step, you must be logged in as superuser.
 
@@ -17,7 +18,7 @@ sudo su -
 
 Before setting up the repository, you need to register with EDB. To receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request).
 
-## Setting 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 these steps.
 
@@ -42,7 +43,7 @@ SUSEConnect -p PackageHub/15.3/x86_64
 zypper refresh
 ```
 
-## Installing the Package
+## Installing the package
 
 ```shell
 zypper -n install edb-efm<4x>
@@ -51,3 +52,13 @@ zypper -n install edb-efm<4x>
 Where <4x> is the version of Failover Manager you are installing.
 
 
+## Initial configuration
+
+If you are using Failover Manager to monitor a cluster owned by a user other than enterprisedb or postgres, see [Extending Failover Manager permissions](../../04_configuring_efm/04_extending_efm_permissions/#extending_efm_permissions).
+
+After installing on each node of the cluster:
+
+1.  Modify the [cluster properties file](../../04_configuring_efm/01_cluster_properties/#cluster_properties) on each node.
+2.  Modify the [cluster members file](../../04_configuring_efm/03_cluster_members/#cluster_members) on each node.
+3.  If applicable, configure and test virtual IP address settings and any scripts that are identified in the cluster properties file.
+4.  Start the agent on each node of the cluster. For more information, see [Controlling the Failover Manager service](../../08_controlling_efm_service/#controlling-the-failover-manager-service).