From 398d60dc8b45f5bceda81941f088100d3e4ac820 Mon Sep 17 00:00:00 2001 From: Akshay Gadhave Date: Thu, 7 Aug 2025 15:20:13 +0530 Subject: [PATCH 1/4] Create an overview of the installation procedure Adding a module for installation overview with high level steps and links to each step. JIRA: https://issues.redhat.com/browse/SAT-30834 --- .../modules/con_overview-of-installation.adoc | 37 +++++++++++++++++++ guides/doc-Installing_Server/master.adoc | 2 + 2 files changed, 39 insertions(+) create mode 100644 guides/common/modules/con_overview-of-installation.adoc diff --git a/guides/common/modules/con_overview-of-installation.adoc b/guides/common/modules/con_overview-of-installation.adoc new file mode 100644 index 0000000000..e0aa99cfab --- /dev/null +++ b/guides/common/modules/con_overview-of-installation.adoc @@ -0,0 +1,37 @@ +:_mod-docs-content-type: CONCEPT + +[id="overview-of-the-installation-process"] += Overview of the installation process + +. Deploy and configure a {EL} system. +For more information, see xref::planning-{project-context}-server-installation_{context}[] +. Configure your network environment for {Project} installation. +For more information, see xref:preparing-environment-for-{project-context}-server-installation[] +. Optional: If you want to use an external DB +For more information, see xref:preparing-for-using-external-databases[] +ifdef::satellite,katello,orcharhino[] +. Optional: If you use an HTTP proxy, configure the proxy to connect to Red{nbsp}Hat CDN. +For more information, see xref:configuring-http-proxy-to-connect-to-cdn[] +endif::[] +ifdef::satellite[] +. Register the {EL} system to RHSM. +For more information, see xref:registering-to-red-hat-subscription-management[] +endif::[] +. Configure repositories for installation. +For more information, see xref:configuring-repositories[] +. Install the {Project} packages. +For more information, see xref:Installing_Server_Packages[] +. Execute the {foreman-installer} +For more information, see xref:configuring-server[] +ifdef::satellite[] +. Import the Red{nbsp}Hat subscription manifest +For more information, see xref:Importing_a_Red_Hat_Subscription_Manifest_into_Server[] +endif::[] +. Optional: Review and perform any additional configuration +xref:performing-additional-configuration-on-server[] + +.Additional resources +* {PlanningDocURL}[{PlanningDocTitle}] +ifdef::satellite[] +* xref:upgrade-helper-app[] +endif::[] diff --git a/guides/doc-Installing_Server/master.adoc b/guides/doc-Installing_Server/master.adoc index 23dd132d5f..953b8927f6 100644 --- a/guides/doc-Installing_Server/master.adoc +++ b/guides/doc-Installing_Server/master.adoc @@ -21,6 +21,8 @@ ifdef::satellite[] include::common/modules/con_red-hat-helper-app.adoc[leveloffset=+1] endif::[] +include::common/modules/con_overview-of-installation.adoc[leveloffset=+1] + include::common/assembly_planning-project-server-installation.adoc[leveloffset=+1] include::common/assembly_preparing-environment-for-project-server-installation.adoc[leveloffset=+1] From 66433494ec99ec0ea03ea53ed5a49dde97bde4bd Mon Sep 17 00:00:00 2001 From: Akshay Gadhave Date: Tue, 12 Aug 2025 11:11:33 +0530 Subject: [PATCH 2/4] Fix xrefs --- .../modules/con_overview-of-installation.adoc | 23 ++++++++----------- 1 file changed, 10 insertions(+), 13 deletions(-) diff --git a/guides/common/modules/con_overview-of-installation.adoc b/guides/common/modules/con_overview-of-installation.adoc index e0aa99cfab..a14c72a771 100644 --- a/guides/common/modules/con_overview-of-installation.adoc +++ b/guides/common/modules/con_overview-of-installation.adoc @@ -4,34 +4,31 @@ = Overview of the installation process . Deploy and configure a {EL} system. -For more information, see xref::planning-{project-context}-server-installation_{context}[] +For more information, see xref:planning-{project-context}-server-installation_{context}[] . Configure your network environment for {Project} installation. -For more information, see xref:preparing-environment-for-{project-context}-server-installation[] +For more information, see xref:preparing-environment-for-{project-context}-server-installation_{context}[] . Optional: If you want to use an external DB -For more information, see xref:preparing-for-using-external-databases[] +For more information, see xref:preparing-for-using-external-databases_{context}[] ifdef::satellite,katello,orcharhino[] . Optional: If you use an HTTP proxy, configure the proxy to connect to Red{nbsp}Hat CDN. -For more information, see xref:configuring-http-proxy-to-connect-to-cdn[] +For more information, see xref:configuring-http-proxy-to-connect-to-cdn_{context}[] endif::[] ifdef::satellite[] . Register the {EL} system to RHSM. -For more information, see xref:registering-to-red-hat-subscription-management[] +For more information, see xref:registering-to-red-hat-subscription-management_{context}[] endif::[] . Configure repositories for installation. -For more information, see xref:configuring-repositories[] +For more information, see xref:configuring-repositories_{context}[] . Install the {Project} packages. -For more information, see xref:Installing_Server_Packages[] +For more information, see xref:Installing_Server_Packages_{context}[] . Execute the {foreman-installer} -For more information, see xref:configuring-server[] +For more information, see xref:configuring-server_{context}[] ifdef::satellite[] . Import the Red{nbsp}Hat subscription manifest -For more information, see xref:Importing_a_Red_Hat_Subscription_Manifest_into_Server[] +For more information, see xref:Importing_a_Red_Hat_Subscription_Manifest_into_Server_{context}[] endif::[] . Optional: Review and perform any additional configuration -xref:performing-additional-configuration-on-server[] +xref:performing-additional-configuration-on-server_{context}[] .Additional resources * {PlanningDocURL}[{PlanningDocTitle}] -ifdef::satellite[] -* xref:upgrade-helper-app[] -endif::[] From 6ad78afd1b934de0e19a882c61530004c3865e8e Mon Sep 17 00:00:00 2001 From: Akshay Gadhave Date: Tue, 23 Sep 2025 12:21:07 +0530 Subject: [PATCH 3/4] Rework overview to descriptive text --- .../modules/con_overview-of-installation.adoc | 52 +++++++++---------- 1 file changed, 26 insertions(+), 26 deletions(-) diff --git a/guides/common/modules/con_overview-of-installation.adoc b/guides/common/modules/con_overview-of-installation.adoc index a14c72a771..b1cdc36c08 100644 --- a/guides/common/modules/con_overview-of-installation.adoc +++ b/guides/common/modules/con_overview-of-installation.adoc @@ -3,32 +3,32 @@ [id="overview-of-the-installation-process"] = Overview of the installation process -. Deploy and configure a {EL} system. -For more information, see xref:planning-{project-context}-server-installation_{context}[] -. Configure your network environment for {Project} installation. -For more information, see xref:preparing-environment-for-{project-context}-server-installation_{context}[] -. Optional: If you want to use an external DB -For more information, see xref:preparing-for-using-external-databases_{context}[] -ifdef::satellite,katello,orcharhino[] -. Optional: If you use an HTTP proxy, configure the proxy to connect to Red{nbsp}Hat CDN. -For more information, see xref:configuring-http-proxy-to-connect-to-cdn_{context}[] -endif::[] -ifdef::satellite[] -. Register the {EL} system to RHSM. -For more information, see xref:registering-to-red-hat-subscription-management_{context}[] -endif::[] -. Configure repositories for installation. -For more information, see xref:configuring-repositories_{context}[] -. Install the {Project} packages. -For more information, see xref:Installing_Server_Packages_{context}[] -. Execute the {foreman-installer} -For more information, see xref:configuring-server_{context}[] -ifdef::satellite[] -. Import the Red{nbsp}Hat subscription manifest -For more information, see xref:Importing_a_Red_Hat_Subscription_Manifest_into_Server_{context}[] -endif::[] -. Optional: Review and perform any additional configuration -xref:performing-additional-configuration-on-server_{context}[] +The {Project} installation process can be broken down into three main phases: +* Planning +* Server preparation +* Installation and configuration + +.Planning +Make sure that your infrastructure meets the prerequisites for installation: + +* Ensure your hardware and software meet the minimum requirements for CPU, RAM, and storage space. +* Plan your network setup, including DNS resolution and port/firewall configurations. +* For large deployments (e.g., more than 5,000 hosts), select a predefined performance profile to optimize your system. + +.Server preparation +Configure the operating system and the repositoties for installating {Project}: + +* Install {EL} 9 on a freshly installed system. +* Verify that the hostname of your {ProjectServer} resolves correctly. +* Configure your system to access the necessary repositories, which contain the {Project} packages. + +.Installation and configuration +Install {Project} packages, execute the `{foreman-installer}`, and perform any additional configuration + +* Install the {Project} package and all its dependencies. +* Use the `{foreman-installer}` command to perform the initial server setup. +* Import your subscription manifest. +* Optional: Enable additional features like remote execution, configuring custom SSL certificates, and email notifications. .Additional resources * {PlanningDocURL}[{PlanningDocTitle}] From 0d4d1aead1e0eff13d4fd97ff454ad7c36ec1618 Mon Sep 17 00:00:00 2001 From: Akshay Gadhave Date: Tue, 30 Sep 2025 12:07:59 +0530 Subject: [PATCH 4/4] Apply changes suggested in PR --- .../modules/con_overview-of-installation.adoc | 27 ++++++++++++------- 1 file changed, 17 insertions(+), 10 deletions(-) diff --git a/guides/common/modules/con_overview-of-installation.adoc b/guides/common/modules/con_overview-of-installation.adoc index b1cdc36c08..ba5f065264 100644 --- a/guides/common/modules/con_overview-of-installation.adoc +++ b/guides/common/modules/con_overview-of-installation.adoc @@ -3,31 +3,38 @@ [id="overview-of-the-installation-process"] = Overview of the installation process -The {Project} installation process can be broken down into three main phases: +The {Project} installation process consists of the following main phases: * Planning * Server preparation * Installation and configuration -.Planning +Planning:: Make sure that your infrastructure meets the prerequisites for installation: * Ensure your hardware and software meet the minimum requirements for CPU, RAM, and storage space. -* Plan your network setup, including DNS resolution and port/firewall configurations. -* For large deployments (e.g., more than 5,000 hosts), select a predefined performance profile to optimize your system. - -.Server preparation -Configure the operating system and the repositoties for installating {Project}: - -* Install {EL} 9 on a freshly installed system. +* Plan your network setup, including DNS resolution and port and firewall configuration. +* For large deployments of more than 5,000 hosts, consider using a predefined tuning profile to optimize {Project} performance. + +Server preparation:: +Configure the operating system and the repositories for installing {Project}: + +ifndef::foreman-deb[] +* Install {EL} 9 on a newly deployed system. +endif::[] +ifdef::foreman-deb[] +* Install Debian 12 or Ubuntu 22.04 on a newly deployed system. +endif::[] * Verify that the hostname of your {ProjectServer} resolves correctly. * Configure your system to access the necessary repositories, which contain the {Project} packages. -.Installation and configuration +Installation and configuration:: Install {Project} packages, execute the `{foreman-installer}`, and perform any additional configuration * Install the {Project} package and all its dependencies. * Use the `{foreman-installer}` command to perform the initial server setup. +ifndef::foreman-el,foreman-deb[] * Import your subscription manifest. +endif::[] * Optional: Enable additional features like remote execution, configuring custom SSL certificates, and email notifications. .Additional resources