Skip to content

Commit 5fcb943

Browse files
AkshayGadhaveRHAkshay Gadhave
AkshayGadhaveRH
and
Akshay Gadhave
authored
Make Updating guide ready for DITA migration (#4314)
* Make Updating guide ready for DITA migration * Remove discrete headings * Add + to ensure continuous procedures * Add abstract role * Other minor changes --------- Co-authored-by: Akshay Gadhave <[email protected]>
1 parent 3b108fa commit 5fcb943

10 files changed

+86
-69
lines changed

‎guides/common/assembly_updating-satellite.adoc‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ include::modules/proc_updating-server.adoc[]
44

55
include::modules/proc_updating-disconnected-server.adoc[]
66

7-
include::modules/proc_updating-disconnected-server-on-EL9.adoc[leveloffset=+1]
7+
include::modules/proc_preparing-the-repositories-for-export.adoc[leveloffset=+1]
8+
9+
include::modules/proc_updating-the-disconnected-project.adoc[leveloffset=+1]
810

911
include::modules/proc_updating-smart-proxy.adoc[]

‎guides/common/modules/con_updating-project-to-next-patch-version.adoc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
[id="updating-project-to-next-patch-version_{context}"]
44
= Updating {Project} to the next patch version
55

6+
[role="_abstract"]
67
You can update your {ProjectServer} and {SmartProxyServer} to a new patch release version, such as from {ProjectVersion}.0 to {ProjectVersion}.1, by using the {Project} maintain tool.
78
The patch releases are non-disruptive to your operating environment and often fast.
89

‎guides/common/modules/con_updating-project.adoc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
[id="updating-{project-context}"]
44
= Updating {Project}
55

6+
[role="_abstract"]
67
ifdef::orcharhino[]
78
{Team} provides updates for your base operating system and backported bugfixes for {Project}.
89
You can use this procedure to apply those updates.

‎guides/common/modules/proc_updating-disconnected-server-on-EL9.adoc‎ renamed to ‎guides/common/modules/proc_preparing-the-repositories-for-export.adoc‎

Lines changed: 5 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
:_mod-docs-content-type: PROCEDURE
22

3-
[id="Updating-Disconnected-{project-context}-on-EL9_{context}"]
4-
= Updating a disconnected {ProjectServer} on {RHEL} 9
3+
[id="preparing-the-repositories-for-export"]
4+
= Preparing the repositories for export
55

6-
You can update your disconnected {Project} on {RHEL} 9 by synchronizing the required repositories on the connected {Project} and syncing the content to the disconnected {Project} using `reposync`.
6+
[role="_abstract"]
7+
Prepare the required repositories on the connected {Project} to export to the disconnected {Project}.
78

8-
.Procedure on the connected {ProjectServer}
9+
.Procedure
910
. Ensure that you have synchronized the following repositories in your connected {ProjectServer}:
1011
+
1112
* {RepoRHEL9BaseOS}
@@ -88,63 +89,3 @@ This downloads the contents of the repositories from the connected {ProjectServe
8889
# tar czf {Project}-repos.tgz -C ~ {Project}-repos
8990
----
9091
. Use the generated `{Project}-repos.tgz` file to update in the disconnected {ProjectServer}.
91-
92-
.Procedure on the disconnected {ProjectServer}
93-
. Copy the generated `{Project}-repos.tgz` file to your disconnected {ProjectServer}.
94-
. Extract the archive to anywhere accessible by the `root` user.
95-
In the following example `/root` is the extraction location.
96-
+
97-
[options="nowrap" subs="+quotes,verbatim,attributes"]
98-
----
99-
# tar zxf {Project}-repos.tgz -C /root
100-
----
101-
. Create a Yum configuration file under `/etc/yum.repos.d` with the following repository information:
102-
+
103-
[options="nowrap" subs="+quotes,verbatim,attributes"]
104-
----
105-
[{RepoRHEL9BaseOS}]
106-
name=Red Hat Enterprise Linux 9 for x86_64 - BaseOS (RPMs)
107-
baseurl=file:///root/{Project}-repos/{RepoRHEL9BaseOS}
108-
enabled = 1
109-
110-
[{RepoRHEL9AppStream}]
111-
name=Red Hat Enterprise Linux 9 for x86_64 - AppStream (RPMs)
112-
baseurl=file:///root/{Project}-repos/{RepoRHEL9AppStream}
113-
enabled = 1
114-
115-
[{RepoRHEL9ServerSatelliteServerProjectVersion}]
116-
name={ProjectNameX} for RHEL 9 Server RPMs x86_64
117-
baseurl=file:///root/{Project}-repos/{RepoRHEL9ServerSatelliteServerProjectVersion}
118-
enabled = 1
119-
120-
[{RepoRHEL9ServerSatelliteMaintenanceProjectVersion}]
121-
name={ProjectName} Maintenance 6 for RHEL 9 Server RPMs x86_64
122-
baseurl=file:///root/{Project}-repos/{RepoRHEL9ServerSatelliteMaintenanceProjectVersion}
123-
enabled = 1
124-
----
125-
. In the configuration file, replace the `/root/{Project}-repos` with the extracted location.
126-
. Use the health check option to determine if the system is ready for update.
127-
On first use of this command, `{foreman-maintain}` prompts you to enter the hammer admin user credentials and saves them in the `/etc/foreman-maintain/foreman-maintain-hammer.yml` file.
128-
+
129-
[options="nowrap" subs="+quotes,verbatim,attributes"]
130-
----
131-
# {foreman-maintain} update check \
132-
--whitelist="check-upstream-repository,repositories-validate"
133-
----
134-
. Review the results and address any highlighted error conditions before performing the update.
135-
. Due to the lengthy update time, use a utility such as `tmux` to suspend and reattach a communication session.
136-
You can then check the update progress without staying connected to the command shell continuously.
137-
+
138-
If you lose connection to the command shell where the update command is running, you can see the logged messages in the `{installer-log-file}` file to check if the process completed successfully.
139-
. Perform the update:
140-
+
141-
[options="nowrap" subs="+quotes,verbatim,attributes"]
142-
----
143-
# {foreman-maintain} update run \
144-
--whitelist="check-upstream-repository,repositories-setup,repositories-validate"
145-
----
146-
147-
include::snip_steps-needs-reboot.adoc[]
148-
149-
.Additional resources
150-
* To restore the backup of the {ProjectServer} or {SmartProxyServer}, see {AdministeringDocURL}Restoring_from_a_Full_Backup_admin[Restoring {ProjectServer} or {SmartProxyServer} from a Backup].

‎guides/common/modules/proc_updating-disconnected-server.adoc‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
[id="Updating-Disconnected-{project-context}_{context}"]
44
= Updating a disconnected {ProjectServer}
55

6-
Update your air-gapped {Project} setup where the connected {ProjectServer}, which synchronizes content from CDN, is air gapped from a disconnected {ProjectServer}, to the next patch version.
6+
[role="_abstract"]
7+
Update your air-gapped {Project} setup where the connected {ProjectServer}, which synchronizes content from CDN, is air-gapped from a disconnected {ProjectServer}, to the next patch version.
78
You can follow this process to update the underlying operating system between minor release versions.
89

910
.Prerequisites

‎guides/common/modules/proc_updating-foreman-server.adoc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
[id="updating-{project-context}-server"]
44
= Updating {ProjectServer}
55

6+
[role="_abstract"]
67
You can update your {ProjectServer} to the latest packages published by {Team}.
78

89
.Procedure

‎guides/common/modules/proc_updating-server.adoc‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
[id="Updating_Server_{context}"]
44
= Updating {ProjectServer}
55

6+
[role="_abstract"]
67
ifdef::satellite[]
78
Update your connected {ProjectServer} to the next patch version.
89
You can follow this process to update the underlying operating system between minor release versions.
@@ -47,8 +48,8 @@ If you lose connection to the command shell where the update command is running,
4748
----
4849
# {foreman-maintain} update run
4950
----
50-
51+
+
5152
include::snip_steps-needs-reboot.adoc[]
5253

5354
.Additional resources
54-
* To restore the backup of the {ProjectServer} or {SmartProxyServer}, see {AdministeringDocURL}Restoring_from_a_Full_Backup_admin[Restoring {ProjectServer} or {SmartProxyServer} from a Backup]
55+
* {AdministeringDocURL}Restoring_from_a_Full_Backup_admin[Restoring {ProjectServer} or {SmartProxyServer} from a Backup]

‎guides/common/modules/proc_updating-smart-proxy-server.adoc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
[id="updating-{smart-proxy-context}-server"]
44
= Updating {SmartProxyServer}
55

6+
[role="_abstract"]
67
You can update your {SmartProxyServer} to the latest packages published by {Team}.
78

89
ifdef::orcharhino[]

‎guides/common/modules/proc_updating-smart-proxy.adoc‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
[id="Updating-Smart-Proxy_{context}"]
44
= Updating {SmartProxyServer}
55

6+
[role="_abstract"]
67
Update {SmartProxyServers} to the next patch version.
78

89
.Procedure
@@ -38,5 +39,5 @@ endif::[]
3839
----
3940
# {foreman-maintain} update run
4041
----
41-
42+
+
4243
include::snip_steps-needs-reboot.adoc[]

‎guides/common/modules/proc_updating-the-disconnected-project.adoc‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
:_mod-docs-content-type: PROCEDURE
2+
3+
[id="Updating-the-Disconnected-{project-context}_{context}"]
4+
= Updating the disconnected {ProjectServer}
5+
6+
[role="_abstract"]
7+
Create local repositories on your disconnected {Project} and update the disconnected {Project}.
8+
9+
.Procedure
10+
. Copy the generated `{Project}-repos.tgz` file to your disconnected {ProjectServer}.
11+
. Extract the archive to anywhere accessible by the `root` user.
12+
In the following example `/root` is the extraction location.
13+
+
14+
[options="nowrap" subs="+quotes,verbatim,attributes"]
15+
----
16+
# tar zxf {Project}-repos.tgz -C /root
17+
----
18+
. Create a Yum configuration file under `/etc/yum.repos.d` with the following repository information:
19+
+
20+
[options="nowrap" subs="+quotes,verbatim,attributes"]
21+
----
22+
[{RepoRHEL9BaseOS}]
23+
name=Red Hat Enterprise Linux 9 for x86_64 - BaseOS (RPMs)
24+
baseurl=file:///root/{Project}-repos/{RepoRHEL9BaseOS}
25+
enabled = 1
26+
27+
[{RepoRHEL9AppStream}]
28+
name=Red Hat Enterprise Linux 9 for x86_64 - AppStream (RPMs)
29+
baseurl=file:///root/{Project}-repos/{RepoRHEL9AppStream}
30+
enabled = 1
31+
32+
[{RepoRHEL9ServerSatelliteServerProjectVersion}]
33+
name={ProjectNameX} for RHEL 9 Server RPMs x86_64
34+
baseurl=file:///root/{Project}-repos/{RepoRHEL9ServerSatelliteServerProjectVersion}
35+
enabled = 1
36+
37+
[{RepoRHEL9ServerSatelliteMaintenanceProjectVersion}]
38+
name={ProjectName} Maintenance 6 for RHEL 9 Server RPMs x86_64
39+
baseurl=file:///root/{Project}-repos/{RepoRHEL9ServerSatelliteMaintenanceProjectVersion}
40+
enabled = 1
41+
----
42+
. In the configuration file, replace the `/root/{Project}-repos` with the extracted location.
43+
. Use the health check option to determine if the system is ready for update.
44+
On first use of this command, `{foreman-maintain}` prompts you to enter the hammer admin user credentials and saves them in the `/etc/foreman-maintain/foreman-maintain-hammer.yml` file.
45+
+
46+
[options="nowrap" subs="+quotes,verbatim,attributes"]
47+
----
48+
# {foreman-maintain} update check \
49+
--whitelist="check-upstream-repository,repositories-validate"
50+
----
51+
. Review the results and address any highlighted error conditions before performing the update.
52+
. Due to the lengthy update time, use a utility such as `tmux` to suspend and reattach a communication session.
53+
You can then check the update progress without staying connected to the command shell continuously.
54+
+
55+
If you lose connection to the command shell where the update command is running, you can see the logged messages in the `{installer-log-file}` file to check if the process completed successfully.
56+
. Perform the update:
57+
+
58+
[options="nowrap" subs="+quotes,verbatim,attributes"]
59+
----
60+
# {foreman-maintain} update run \
61+
--whitelist="check-upstream-repository,repositories-setup,repositories-validate"
62+
----
63+
+
64+
include::snip_steps-needs-reboot.adoc[]
65+
66+
.Additional resources
67+
* {AdministeringDocURL}Restoring_from_a_Full_Backup_admin[Restoring {ProjectServer} or {SmartProxyServer} from a Backup]

0 commit comments

Comments
 (0)