Skip to content

Commit f0af326

Browse files
Show updating Foreman guide for all builds (#4301)
This patch assumes that upstream does not release Z-releases for Foreman/Katello that are upgraded to via "foreman-maintain". Parts of the introduction to orcharhino updates comes from https://docs.orcharhino.com/or/docs/sources/installation_and_maintenance/updating_orcharhino.html. Fixes #2280
1 parent 8ddba31 commit f0af326

File tree

7 files changed

+106
-19
lines changed

7 files changed

+106
-19
lines changed
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
include::modules/con_updating-project.adoc[]
2+
3+
include::modules/proc_updating-foreman-server.adoc[leveloffset=+1]
4+
5+
include::modules/proc_updating-smart-proxy-server.adoc[leveloffset=+1]
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
include::modules/con_updating-project-to-next-patch-version.adoc[]
2+
3+
include::modules/proc_updating-server.adoc[]
4+
5+
include::modules/proc_updating-disconnected-server.adoc[]
6+
7+
include::modules/proc_updating-disconnected-server-on-EL9.adoc[leveloffset=+1]
8+
9+
include::modules/proc_updating-smart-proxy.adoc[]
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
:_mod-docs-content-type: CONCEPT
2+
3+
[id="updating-{project-context}"]
4+
= Updating {Project}
5+
6+
ifdef::orcharhino[]
7+
{Team} provides updates for your base operating system and backported bugfixes for {Project}.
8+
You can use this procedure to apply those updates.
9+
10+
If you want to upgrade {Project} to the next version, see xref:sources/installation_and_maintenance/upgrading_orcharhino_server.adoc[Upgrading {ProjectServer}] or xref:sources/installation_and_maintenance/upgrading_orcharhino_proxy_server.adoc[Upgrading {SmartProxyServer}].
11+
endif::[]
12+
13+
ifndef::orcharhino[]
14+
{Team} recommends that you perform updates regularly to resolve security vulnerabilities and other issues.
15+
endif::[]
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
:_mod-docs-content-type: PROCEDURE
2+
3+
[id="updating-{project-context}-server"]
4+
= Updating {ProjectServer}
5+
6+
You can update your {ProjectServer} to the latest packages published by {Team}.
7+
8+
.Procedure
9+
. On your {ProjectServer}, start {Project} maintenance mode:
10+
+
11+
[options="nowrap" subs="+quotes,verbatim,attributes"]
12+
----
13+
# {foreman-maintain} maintenance-mode start
14+
----
15+
. Upgrade all packages:
16+
+
17+
[options="nowrap" subs="+quotes,verbatim,attributes"]
18+
----
19+
# {project-package-update}
20+
----
21+
. Reconfigure {ProjectServer}:
22+
+
23+
[options="nowrap" subs="+quotes,verbatim,attributes"]
24+
----
25+
# {foreman-installer}
26+
----
27+
. Stop {Project} maintenance mode:
28+
+
29+
[options="nowrap" subs="+quotes,verbatim,attributes"]
30+
----
31+
# {foreman-maintain} maintenance-mode stop
32+
----
33+
34+
.Verification
35+
* On your {ProjectServer}, verify that all {Project} services are running:
36+
+
37+
[options="nowrap" subs="+quotes,verbatim,attributes"]
38+
----
39+
# {foreman-maintain} service status -b
40+
----
41+
42+
.Next steps
43+
* Update your {SmartProxyServers}.
44+
For more information, see xref:updating-{smart-proxy-context}-server[]
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
:_mod-docs-content-type: PROCEDURE
2+
3+
[id="updating-{smart-proxy-context}-server"]
4+
= Updating {SmartProxyServer}
5+
6+
You can update your {SmartProxyServer} to the latest packages published by {Team}.
7+
8+
ifdef::orcharhino[]
9+
.Prerequisites
10+
* Ensure that you have synchronized the `{SmartProxy}` product to {ProjectServer}.
11+
endif::[]
12+
13+
.Procedure
14+
. On your {SmartProxyServer}, upgrade all packages:
15+
+
16+
[options="nowrap" subs="+quotes,verbatim,attributes"]
17+
----
18+
# {project-package-update}
19+
----
20+
. Reconfigure {SmartProxyServer}:
21+
+
22+
[options="nowrap" subs="+quotes,verbatim,attributes"]
23+
----
24+
# {foreman-installer}
25+
----

guides/doc-Updating_Project/master.adoc

Lines changed: 3 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -5,28 +5,14 @@ include::common/header.adoc[]
55

66
= {UpdatingDocTitle}
77

8-
// This guide is not ready because it uses foreman-maintain to update to .z
9-
// releases but that is not implemented upstream
10-
ifdef::foreman-el,foreman-deb,katello[]
11-
include::common/modules/con_guide-not-ready.adoc[leveloffset=+1]
12-
endif::[]
13-
ifndef::foreman-el,foreman-deb,katello[]
14-
158
ifdef::satellite[]
169
include::common/modules/proc_providing-feedback-on-red-hat-documentation.adoc[leveloffset=+1]
17-
endif::[]
18-
19-
include::common/modules/con_updating-project-to-next-patch-version.adoc[leveloffset=+1]
20-
21-
include::common/modules/proc_updating-server.adoc[leveloffset=+1]
22-
23-
ifdef::satellite[]
24-
include::common/modules/proc_updating-disconnected-server.adoc[leveloffset=+1]
2510

26-
include::common/modules/proc_updating-disconnected-server-on-EL9.adoc[leveloffset=+2]
11+
include::common/assembly_updating-satellite.adoc[leveloffset=+1]
2712
endif::[]
2813

29-
include::common/modules/proc_updating-smart-proxy.adoc[leveloffset=+1]
14+
ifndef::satellite[]
15+
include::common/assembly_updating-foreman.adoc[leveloffset=+1]
3016
endif::[]
3117

3218
ifndef::orcharhino,satellite[]

web/releases/nightly.json

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
["Planning_for_Project", "Planning for Foreman with Katello"],
1919
["Installing_Server", "Installing Katello Server"],
2020
["Installing_Proxy", "Installing Smart Proxy Server with content"],
21+
["Updating_Project", "Updating Foreman with Katello"],
2122
["Configuring_Load_Balancer", "Configuring Smart Proxies with a load balancer"]
2223
],
2324
"Administering Foreman server": [
@@ -61,7 +62,8 @@
6162
"Deploying Foreman": [
6263
["Planning_for_Project", "Planning for Foreman"],
6364
["Installing_Server", "Installing Foreman Server"],
64-
["Installing_Proxy", "Installing Smart Proxy Server"]
65+
["Installing_Proxy", "Installing Smart Proxy Server"],
66+
["Updating_Project", "Updating Foreman"]
6567
],
6668
"Administering Foreman server": [
6769
["Administering_Project", "Administering Foreman"],
@@ -103,7 +105,8 @@
103105
"Deploying Foreman": [
104106
["Planning_for_Project", "Planning for Foreman"],
105107
["Installing_Server", "Installing Foreman Server"],
106-
["Installing_Proxy", "Installing Smart Proxy Server"]
108+
["Installing_Proxy", "Installing Smart Proxy Server"],
109+
["Updating_Project", "Updating Foreman"]
107110
],
108111
"Administering Foreman server": [
109112
["Administering_Project", "Administering Foreman"],

0 commit comments

Comments
 (0)