Skip to content

Create an overview of the installation procedure #4120

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Create an overview of the installation procedure #4120

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
398d60d
Create an overview of the installation procedure
Aug 7, 2025
6643349
Fix xrefs
Aug 12, 2025
6ad78af
Rework overview to descriptive text
Sep 23, 2025
0d4d1ae
Apply changes suggested in PR
Sep 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions guides/common/modules/con_overview-of-installation.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
:_mod-docs-content-type: CONCEPT

[id="overview-of-the-installation-process"]
= Overview of the installation process

The {Project} installation process consists of the following 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 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::[]
Comment on lines +21 to +26
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It still sounds strange to me because "install" and "deploy" could be considered (partial) synonyms. (Or at least software installation is part of deployment, the way I see it.)

What about something like this?

Suggested change
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::[]
ifndef::foreman-deb[]
* Ensure a fresh installation of {EL} 9 on your server.
endif::[]
ifdef::foreman-deb[]
* Ensure a fresh installation of Debian 12 or Ubuntu 22.04 on your server.
endif::[]

Feel free to get a second opinion. I'm not sure how to say this either :)

Copy link
Contributor

@Lennonka Lennonka Sep 30, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alternative:

Suggested change
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::[]
ifndef::foreman-deb[]
* Deploy a server with a fresh {EL} 9 installation.
endif::[]
ifdef::foreman-deb[]
* Deploy a server with a fresh Debian 12 or Ubuntu 22.04 installation.
endif::[]

Or even:

Suggested change
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::[]
ifndef::foreman-deb[]
* Deploy a server with fresh {EL} 9.
endif::[]
ifdef::foreman-deb[]
* Deploy a server with fresh Debian 12 or Ubuntu 22.04.
endif::[]

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I also see installing as a part of a deployment. For example, a deployment may also include creating the server (like a VM) with the right size. You then install the software on that server.

* 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.
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
* {PlanningDocURL}[{PlanningDocTitle}]
2 changes: 2 additions & 0 deletions guides/doc-Installing_Server/master.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
Loading