Skip to content

Commit 4c843e6

Browse files
committed
Rephrase system requirements into actionable steps
1 parent 1e8ac34 commit 4c843e6

File tree

1 file changed

+62
-70
lines changed

1 file changed

+62
-70
lines changed

guides/common/modules/ref_system-requirements.adoc

Lines changed: 62 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -3,105 +3,72 @@
33
[id="system-requirements_{context}"]
44
= System requirements
55

6-
The following requirements apply to the networked base operating system:
6+
ifdef::satellite[]
7+
{ProductName} is fully supported on both physical systems and virtual machines that run on hypervisors that are supported to run {RHEL}.
8+
For more information about certified hypervisors, see https://access.redhat.com/articles/973163[Certified Guest Operating Systems in Red Hat OpenStack Platform, Red Hat Virtualization, Red Hat OpenShift Virtualization and Red Hat Enterprise Linux with KVM].
9+
10+
endif::[]
11+
Follow these system requirements when installing {ProductName}:
712

8-
* x86_64 architecture
13+
* Install {ProductName} on a freshly provisioned system that servers no other function except to run {ProductName}.
14+
Do not use an existing system because the {Project} installer will affect the configuration of several components.
15+
* Ensure you have administrative user (root) access to the system.
16+
* Ensure the system meets the following requirements:
17+
** x86_64 architecture
918
ifdef::satellite[]
10-
* The latest version of {RHEL} 9
19+
** The latest version of {RHEL} 9
1120
endif::[]
12-
* 4-core 2.0 GHz CPU at a minimum
21+
** 4-core 2.0 GHz CPU or higher
1322

1423
ifeval::["{context}" == "{project-context}"]
15-
* A minimum of {project-minimum-memory} RAM is required for {ProjectServer} to function.
16-
ifdef::katello,satellite[]
17-
In addition, a minimum of 4 GB RAM of swap space is also recommended.
24+
** {project-minimum-memory} RAM or higher
1825
endif::[]
19-
{Project} running with less RAM than the minimum value might not operate correctly.
20-
endif::[]
21-
2226
ifeval::["{context}" == "{smart-proxy-context}"]
23-
* A minimum of 12 GB RAM is required for {SmartProxyServer} to function.
24-
In addition, a minimum of 4 GB RAM of swap space is also recommended.
25-
{SmartProxy} running with less RAM than the minimum value might not operate correctly.
27+
** 12 GB RAM or higher
2628
endif::[]
27-
2829
ifdef::katello,satellite[]
29-
* A unique host name, which can contain lower-case letters, numbers, dots (.) and hyphens (-)
30+
** 4 GB RAM of swap space or higher
3031
endif::[]
3132

32-
ifdef::satellite[]
33-
* A current {ProjectName} subscription
33+
ifdef::katello,satellite[]
34+
** A unique host name, which can contain lower-case letters, numbers, dots (.) and hyphens (-)
3435
endif::[]
35-
* Administrative user (root) access
36-
* Full forward and reverse DNS resolution using a fully-qualified domain name
37-
38-
{Project} only supports `UTF-8` encoding.
39-
If your territory is USA and your language is English, set `en_US.utf-8` as the system-wide locale settings.
40-
For more information about configuring system locale in {EL}, see {RHELDocsBaseURL}9/html/configuring_basic_system_settings/assembly_changing-basic-environment-settings_configuring-basic-system-settings#proc_configuring-the-system-locale_assembly_changing-basic-environment-settings[Configuring the system locale] in _{RHEL}{nbsp}9 Configuring basic system settings_.
4136

4237
ifdef::satellite[]
43-
Your {Project} must have the {SatelliteSub} manifest in your Customer Portal.
44-
{Project} must have {project-context}-{smart-proxy-context}-6.x repository enabled and synced.
45-
To create, manage, and export a Red{nbsp}Hat Subscription Manifest in the Customer Portal, see {RHDocsBaseURL}subscription_central/1-latest/html/creating_and_managing_manifests_for_a_connected_satellite_server/index[Creating and managing manifests for a connected {ProjectServer}] in _Subscription Central_.
38+
** A current {ProjectName} subscription
4639
endif::[]
40+
** Full forward and reverse DNS resolution using a fully-qualified domain name
4741

48-
{ProjectServer} and {SmartProxyServer} do not support shortnames in the hostnames.
49-
When using custom certificates, the Common Name (CN) of the custom certificate must be a fully qualified domain name (FQDN) instead of a shortname.
50-
This does not apply to the clients of a {Project}.
51-
52-
Before you install {ProductName}, ensure that your environment meets the requirements for installation.
53-
ifeval::["{context}" == "{smart-proxy-context}"]
54-
[WARNING]
55-
====
56-
The version of {SmartProxy} must match with the version of {Project} installed.
57-
It should not be different.
58-
For example, the {SmartProxy} version {ProjectVersion} cannot be registered with the {Project} version {ProjectVersionPrevious}.
59-
====
60-
endif::[]
61-
62-
Install {ProductName} on a freshly provisioned system that servers no other function except to run {ProductName}.
63-
Do not use an existing system because the {Project} installer will affect the configuration of several components.
64-
65-
The freshly provisioned system must not have the following users provided by external identity providers to avoid conflicts with the local users that {ProductName} creates:
66-
67-
* {apache-user}
42+
* Ensure that the system does not have the following users provided by external identity providers.
43+
These user accounts can cause conflicts with the local users that {ProductName} creates:
44+
** {apache-user}
6845
ifeval::["{context}" == "{project-context}"]
69-
* foreman
46+
** foreman
7047
endif::[]
71-
* foreman-proxy
72-
* postgres
48+
** foreman-proxy
49+
** postgres
7350
ifdef::katello,satellite,orcharhino[]
74-
* pulp
51+
** pulp
7552
endif::[]
76-
* puppet
77-
* redis
53+
** puppet
54+
** redis
7855
ifdef::katello,satellite,orcharhino[]
7956
ifeval::["{context}" == "{project-context}"]
80-
* tomcat
81-
endif::[]
82-
endif::[]
83-
84-
ifdef::satellite[]
85-
ifeval::["{context}" == "{smart-proxy-context}"]
86-
For more information on scaling your {SmartProxyServers}, see {InstallingSmartProxyDocURL}{smart-proxy-context}-server-scalability-considerations_{smart-proxy-context}[{SmartProxyServer} scalability considerations].
57+
** tomcat
8758
endif::[]
8859
endif::[]
8960

90-
ifdef::satellite[]
91-
.Certified hypervisors
92-
{ProductName} is fully supported on both physical systems and virtual machines that run on hypervisors that are supported to run {RHEL}.
93-
For more information about certified hypervisors, see https://access.redhat.com/articles/973163[Certified Guest Operating Systems in Red Hat OpenStack Platform, Red Hat Virtualization, Red Hat OpenShift Virtualization and Red Hat Enterprise Linux with KVM].
94-
endif::[]
61+
* If you use custom certificates, ensure that the Common Name (CN) of the custom certificate is a fully qualified domain name (FQDN).
62+
Ensure that {ProjectServer} and {SmartProxyServer} do not support shortnames in the hostnames.
63+
This does not apply to the clients of a {Project}.
9564

9665
ifdef::foreman-el,katello,satellite[]
97-
.SELinux mode
98-
SELinux must be enabled, either in enforcing or permissive mode.
66+
* Ensure that SELinux is enabled, either in enforcing or permissive mode.
9967
Installation with disabled SELinux is not supported.
10068
For more information, see {PlanningDocURL}security-considerations[Security considerations] in _{PlanningDocTitle}_.
10169
endif::[]
10270

103-
.Synchronized system clock
104-
The system clock on the base operating system where you are installing your {ProductName} must be synchronized across the network.
71+
* Ensure that the system clock on the system is synchronized across the network.
10572
If the system clock is not synchronized, SSL certificate verification might fail.
10673
ifdef::satellite[]
10774
For example, you can use the Chrony suite for timekeeping.
@@ -110,9 +77,34 @@ endif::[]
11077

11178
ifdef::satellite[]
11279
ifeval::["{context}" == "{project-context}"]
113-
.{ISS} (ISS)
114-
In a scenario with air-gapped {ProjectServer}s, all your {ProjectServer}s must be on the same {Project} version for ISS Export Sync to work.
80+
* If you are installing in an environment with air-gapped {ProjectServer}s, ensure that all your {ProjectServer}s are on the same {Project} version for ISS Export Sync to work.
11581
ISS Network Sync works across all {Project} versions that support it.
11682
For more information, see {ContentManagementDocURL}Synchronizing_Content_Between_Servers_content-management[Synchronizing Content Between {Project} Servers] in _{ContentManagementDocTitle}_.
11783
endif::[]
11884
endif::[]
85+
86+
{Project} only supports `UTF-8` encoding.
87+
If your territory is USA and your language is English, set `en_US.utf-8` as the system-wide locale settings.
88+
For more information about configuring system locale in {EL}, see {RHELDocsBaseURL}9/html/configuring_basic_system_settings/assembly_changing-basic-environment-settings_configuring-basic-system-settings#proc_configuring-the-system-locale_assembly_changing-basic-environment-settings[Configuring the system locale] in _{RHEL}{nbsp}9 Configuring basic system settings_.
89+
90+
ifdef::satellite[]
91+
Your {Project} must have the {SatelliteSub} manifest in your Customer Portal.
92+
{Project} must have {project-context}-{smart-proxy-context}-6.x repository enabled and synced.
93+
To create, manage, and export a Red{nbsp}Hat Subscription Manifest in the Customer Portal, see {RHDocsBaseURL}subscription_central/1-latest/html/creating_and_managing_manifests_for_a_connected_satellite_server/index[Creating and managing manifests for a connected {ProjectServer}] in _Subscription Central_.
94+
endif::[]
95+
96+
ifeval::["{context}" == "{smart-proxy-context}"]
97+
[WARNING]
98+
====
99+
The version of {SmartProxy} must match with the version of {Project} installed.
100+
It should not be different.
101+
For example, the {SmartProxy} version {ProjectVersion} cannot be registered with the {Project} version {ProjectVersionPrevious}.
102+
====
103+
endif::[]
104+
105+
106+
ifdef::satellite[]
107+
ifeval::["{context}" == "{smart-proxy-context}"]
108+
For more information on scaling your {SmartProxyServers}, see {InstallingSmartProxyDocURL}{smart-proxy-context}-server-scalability-considerations_{smart-proxy-context}[{SmartProxyServer} scalability considerations].
109+
endif::[]
110+
endif::[]

0 commit comments

Comments
 (0)