Skip to content

Commit f401342

Browse files
aneta-petrovabangelic
aneta-petrova
and
bangelic
committed
Review OS prerequisites and move them
Rename OS prereq section Move OS requirements before system reqs Move OS table to the beginning Drop OS requirements They are already in system requirements Simplify wording Use more specific wording Fix capitalization Simplify OS table Simplify satellite conditionals Merge quickstart system reqs with regular system reqs This is necessary because the OS reqs that precede the system reqs in the quickstart guide now include `.Additional resources` so the Quickstart's system reqs need a heading. Split system requirements for quickstart Spell out EL when defining EPEL Drop implementation details from quickstart prereqs Apply suggestions from style review Co-authored-by: Brian Angelica <[email protected]>
1 parent 714d853 commit f401342

File tree

5 files changed

+66
-27
lines changed

5 files changed

+66
-27
lines changed

‎guides/common/assembly_planning-project-server-installation.adoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
include::modules/con_planning-project-server-installation.adoc[]
44

5+
include::modules/ref_operating-system-requirements.adoc[leveloffset=+1]
6+
57
include::modules/ref_system-requirements.adoc[leveloffset=+1]
68

79
include::modules/ref_storage-requirements.adoc[leveloffset=+1]
@@ -10,8 +12,6 @@ ifdef::katello,orcharhino,satellite[]
1012
include::modules/ref_best-practices-for-optimizing-storage.adoc[leveloffset=+1]
1113
endif::[]
1214

13-
include::modules/ref_supported-operating-systems.adoc[leveloffset=+1]
14-
1515
include::modules/ref_port-and-firewall-requirements.adoc[leveloffset=+1]
1616

1717
include::modules/con_aws-requirements.adoc[leveloffset=+1]

‎guides/common/assembly_preparing-environment-for-capsule-installation.adoc‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ ifdef::context[:parent-context: {context}]
77

88
Review the following prerequisites before you install {SmartProxyServer}.
99

10+
// Supported Operating Systems
11+
include::modules/ref_operating-system-requirements.adoc[leveloffset=+1]
12+
1013
// System Requirements
1114
include::modules/ref_system-requirements.adoc[leveloffset=+1]
1215

@@ -17,9 +20,6 @@ include::modules/ref_capsule-storage-requirements.adoc[leveloffset=+1]
1720
include::modules/ref_best-practices-for-optimizing-storage.adoc[leveloffset=+1]
1821
endif::[]
1922

20-
// Supported Operating Systems
21-
include::modules/ref_supported-operating-systems.adoc[leveloffset=+1]
22-
2323
// Port and Firewall Requirements
2424
include::modules/ref_smart-proxy-port-and-firewall-requirements.adoc[leveloffset=+1]
2525

‎guides/common/modules/ref_supported-operating-systems.adoc‎ renamed to ‎guides/common/modules/ref_operating-system-requirements.adoc‎

Lines changed: 25 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,47 @@
11
:_mod-docs-content-type: REFERENCE
22

3-
[id="supported-operating-systems_{context}"]
4-
= Supported operating systems
3+
[id="operating-system-requirements"]
4+
= Operating system requirements
55

6-
ifdef::satellite[]
7-
You can install the operating system from a disc, local ISO image, Kickstart, or any other method that Red{nbsp}Hat supports.
8-
Red{nbsp}Hat {ProductName} is supported on the latest version of {RHEL} 9 that is available at the time when {ProductName} is installed.
9-
Previous versions of {RHEL} including EUS or z-stream are not supported.
10-
endif::[]
6+
The following operating systems are supported for deploying {Project}:
117

12-
The following operating systems are supported by the installer, have packages, and are tested for deploying {Project}:
13-
14-
.Operating systems supported by {foreman-installer}
8+
.Operating systems supported for deploying {Project}
9+
[options="header"]
1510
|====
16-
| Operating System | Architecture | Notes
11+
| Operating system | Architecture
1712
ifdef::foreman-el,katello,orcharhino[]
18-
| {PlanningDocURL}Enterprise_Linux[{EL}] 9 | x86_64 only | EPEL is not supported.
13+
| {EL} 9 | x86_64 only
1914
endif::[]
2015
ifdef::satellite[]
21-
| {RHEL} 9 | x86_64 only |
16+
| {RHEL} 9 | x86_64 only
2217
endif::[]
2318
ifdef::foreman-deb[]
24-
| Debian 12 (Bookworm) | amd64 |
25-
| Ubuntu 22.04 (Jammy) | amd64 |
19+
| Debian 12 (Bookworm) | amd64
20+
| Ubuntu 22.04 (Jammy) | amd64
2621
endif::[]
2722
|====
2823

24+
ifdef::foreman-el,katello,orcharhino[]
25+
Installing {Project} on a system with Extra Packages for Enterprise Linux (EPEL) is not supported.
26+
endif::[]
27+
2928
ifdef::satellite[]
29+
You can install the operating system from a disc, local ISO image, Kickstart, or any other method that Red{nbsp}Hat supports.
30+
31+
Red{nbsp}Hat {ProductName} is supported on the latest version of {RHEL} 9 available at the time of installation.
32+
Previous versions of {RHEL} including EUS or z-stream are not supported.
33+
3034
Red{nbsp}Hat {ProductName} requires a {RHEL} installation with the `@Base` package group with no other package-set modifications, and without third-party configurations or software not directly necessary for the direct operation of the server.
3135
This restriction includes hardening and other non-Red{nbsp}Hat security software.
3236
If you require such software in your infrastructure, install and verify a complete working {ProductName} first, then create a backup of the system before adding any non-Red{nbsp}Hat software.
37+
endif::[]
3338

3439
ifeval::["{context}" == "{smart-proxy-context}"]
3540
Do not register {SmartProxyServer} to the Red{nbsp}Hat Content Delivery Network (CDN).
3641
endif::[]
42+
43+
ifdef::foreman-el,katello,orcharhino[]
44+
.Additional resources
45+
46+
* {PlanningDocURL}Enterprise_Linux[Glossary term for {EL}]
3747
endif::[]

‎guides/common/modules/ref_system-requirements-quickstart.adoc‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
:_mod-docs-content-type: REFERENCE
2+
3+
[id="system-requirements"]
4+
= System requirements
5+
6+
The following operating systems are supported for deploying {Project}:
7+
8+
.Operating systems supported for deploying {Project}
9+
[options="header"]
10+
|====
11+
| Operating system | Architecture
12+
ifdef::foreman-el,katello,orcharhino[]
13+
| {EL} 9 | x86_64 only
14+
endif::[]
15+
ifdef::satellite[]
16+
| {RHEL} 9 | x86_64 only
17+
endif::[]
18+
ifdef::foreman-deb[]
19+
| Debian 12 (Bookworm) | amd64
20+
| Ubuntu 22.04 (Jammy) | amd64
21+
endif::[]
22+
|====
23+
24+
ifdef::foreman-el,katello,orcharhino[]
25+
Installing {Project} on a system with Extra Packages for Enterprise Linux (EPEL) is not supported.
26+
endif::[]
27+
28+
The installation requires {project-minimum-memory} of memory.
29+
30+
This guide assumes that you have a newly installed operating system.
31+
The installer sets up Foreman, a Puppet server, and the Smart Proxy by default.
32+
33+
.Additional resources
34+
* {InstallingServerDocURL}operating-system-requirements[Operating system requirements in _{InstallingServerDocTitle}_]
35+
* {InstallingServerDocURL}system-requirements[System requirements in _{InstallingServerDocTitle}_]

‎guides/doc-Quickstart/master.adoc‎

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,7 @@ It uses native operating system packaging (`.rpm` or `.deb` packages) and adds n
1313
Components include the Foreman web UI, Smart Proxy, a Puppet server, TFTP, DNS and DHCP servers.
1414
It is configurable and the Puppet modules can be read or run in "no-op" mode to see what changes it will make.
1515

16-
include::common/modules/ref_supported-operating-systems.adoc[leveloffset=+1]
17-
18-
The installation requires {project-minimum-memory} of memory.
19-
For more information, see {InstallingServerDocURL}system-requirements_{project-context}[System Requirements].
20-
21-
The Foreman installer uses Puppet to install Foreman.
22-
This guide assumes that you have a newly installed operating system, on which the installer will setup Foreman, a Puppet server, and the Smart Proxy by default.
16+
include::common/modules/ref_system-requirements-quickstart.adoc[leveloffset=+1]
2317

2418
include::common/modules/con_configuring-repositories.adoc[leveloffset=+1]
2519

0 commit comments

Comments
 (0)