Docs to upgrade disconnected foreman/sat #3636

parthaa · 2025-02-03T18:49:53Z

Updates the instructions to upgrade 'in-place' for disconnected environments.

What changes are you introducing?

Adds steps on repositories needed to update a satellite in place for both RHel 8 and 9.

Why are you introducing these changes? (Explanation, links to references, issues, etc.)

The existing instructions for this upgrade is outdated. The existing ones are only relevant upto sat 6.11. 6.12 on wards we have what are called "syncable" exports which is more straight forward.
This commit specifically addresses the latest project version. Another PR will be submitted for 6.16 and before.

Anything else to add? (Considerations, potential downsides, alternative solutions you have explored, etc.)

Checklists

I am okay with my commits getting squashed when you merge this PR.
I am familiar with the contributing guidelines.

Please cherry-pick my commits into:

Foreman 3.13/Katello 4.15 (EL9 only)
Foreman 3.12/Katello 4.14 (Satellite 6.16)
Foreman 3.11/Katello 4.13 (orcharhino 6.11 on EL8 only; orcharhino 7.0 on EL8+EL9)
Foreman 3.10/Katello 4.12
Foreman 3.9/Katello 4.11 (Satellite 6.15; orcharhino 6.8/6.9/6.10)
Foreman 3.8/Katello 4.10
Foreman 3.7/Katello 4.9 (Satellite 6.14)
We do not accept PRs for Foreman older than 3.7.

github-actions · 2025-02-03T18:52:54Z

The PR preview for 3d347e6 is available at theforeman-foreman-documentation-preview-pr-3636.surge.sh

The following output files are affected by this PR:

show diff

show diff as HTML

guides/common/modules/proc_updating-disconnected-server-on-EL9.adoc

jeremylenz · 2025-02-03T18:58:43Z

guides/common/modules/proc_upgrading-a-disconnected-project-server.adoc

+* {RepoRHEL8BaseOS}
+* {RepoRHEL8AppStream}
+* {RepoRHEL8ServerSatelliteServerProjectVersion}


These should be the RHEL9 repos, not RHEL8.

Also need to add a prerequisite that your disconnected 6.16 Satellite must already be on RHEL9 before upgrading. (Can link to the LEAPP documentation as well.)

https://access.redhat.com/solutions/7030156

jeremylenz · 2025-02-03T19:00:44Z

guides/common/modules/proc_upgrading-a-disconnected-project-server.adoc

+metadata_expire=-1
+gpgcheck=0
+cost=500
+baseurl=file:///<baseos location>/content/dist/rhel8/8/x86_64/baseos/os


Suggested change

baseurl=file:///<baseos location>/content/dist/rhel8/8/x86_64/baseos/os

baseurl=file:///<baseos location>/content/dist/rhel9/9/x86_64/baseos/os

jeremylenz · 2025-02-03T19:00:55Z

guides/common/modules/proc_upgrading-a-disconnected-project-server.adoc

+metadata_expire=-1
+gpgcheck=0
+cost=500
+baseurl=file:///<appstream location>/content/dist/rhel8/8/x86_64/appstream/os


Suggested change

baseurl=file:///<appstream location>/content/dist/rhel8/8/x86_64/appstream/os

baseurl=file:///<appstream location>/content/dist/rhel9/9/x86_64/appstream/os

jeremylenz · 2025-02-03T19:01:06Z

guides/common/modules/proc_upgrading-a-disconnected-project-server.adoc

+metadata_expire=-1
+gpgcheck=0
+cost=500
+baseurl=file:///<foreman location>/content/dist/layered/rhel8/x86_64/satellite/6.15/os/


Suggested change

baseurl=file:///<foreman location>/content/dist/layered/rhel8/x86_64/satellite/6.15/os/

baseurl=file:///<foreman location>/content/dist/layered/rhel9/x86_64/satellite/6.17/os/

chris1984 · 2025-02-03T19:04:32Z

We will need to add a link or reference https://access.redhat.com/solutions/7030156 in section 2.2 and have them upgrade to RHEL 9 before starting with the Satellite part

Updates the instructions to upgrade 'in-place' for disconnected environments.

Lennonka

Can we make the instructions more RHEL-neutral for upstream?

Lennonka · 2025-02-05T12:23:59Z

guides/common/modules/proc_updating-disconnected-server-on-EL9.adoc

-. Download the debug certificate of the organization and store it locally at `/etc/pki/katello/certs/org-debug-cert.pem` or a location of your choosing.
-For more information, see {AdministeringDocURL}Creating_an_Organization_Debug_Certificate_admin[Creating an Organization Debug Certificate] in _{AdministeringDocTitle}_.
-. Create a Yum configuration file under `/etc/yum.repos.d`, such as `_{project-context}-disconnected_.repo`, with the following contents:
+. Export these repositories via Syncable format. `hammer content-export complete repository --id=<repo_id> --format=syncable`


Suggested change

. Export these repositories via Syncable format. `hammer content-export complete repository --id=<repo_id> --format=syncable`

. Export these repositories by using syncable format:

+

[options="nowrap" subs="+quotes,verbatim,attributes"]

----

$ hammer content-export complete repository --id=_Repo_ID_ --format=syncable

----

Lennonka · 2025-02-05T12:25:47Z

guides/common/modules/proc_updating-disconnected-server-on-EL9.adoc

+.Procedure on the disconnected {ProjectServer}
+. Copy the exported directories over to your disconnected {ProjectServer}
+
+[options="nowrap" subs="+quotes"]


Suggested change

[options="nowrap" subs="+quotes"]

You probably don't need this here. This introduces a code block.

Lennonka · 2025-02-05T12:26:19Z

guides/common/modules/proc_updating-disconnected-server-on-EL9.adoc

 +
-[options="nowrap" subs="+quotes,verbatim,attributes"]
+[options="nowrap" subs="+quotes"]


Suggested change

[options="nowrap" subs="+quotes"]

[options="nowrap" subs="+quotes,attributes"]

You still need attributes because you're using attributes in the code below.

Lennonka · 2025-02-05T12:27:22Z

guides/common/modules/proc_updating-disconnected-server-on-EL9.adoc

+[Satellite]
+name=Satellite
+mediaid=None
+metadata_expire=-1
+gpgcheck=0
+cost=500
+baseurl=file:///<export location>/content/dist/layered/rhel8/x86_64/satellite/{ProjectVersion}/os/


Suggested change

[Satellite]

name=Satellite

mediaid=None

metadata_expire=-1

gpgcheck=0

cost=500

baseurl=file:///<export location>/content/dist/layered/rhel8/x86_64/satellite/{ProjectVersion}/os/

[{Project}]

name={Project}

mediaid=None

metadata_expire=-1

gpgcheck=0

cost=500

baseurl=file:///<export location>/content/dist/layered/rhel8/x86_64/{project-context}/{ProjectVersion}/os/

Can we upstreamize this? Will it work for Foreman on EL?

Lennonka · 2025-02-05T12:28:21Z

guides/common/modules/proc_updating-disconnected-server-on-EL9.adoc

 . Use the health check option to determine if the system is ready for update.
 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.
-+
+


Suggested change

+

This is needed for proper formatting.

pr-processor bot added the Not yet reviewed label Feb 3, 2025

github-actions bot added Needs tech review Requires a review from the technical perspective Needs style review Requires a review from docs style/grammar perspective Needs testing Requires functional testing labels Feb 3, 2025

jeremylenz reviewed Feb 3, 2025

View reviewed changes

pr-processor bot removed the Not yet reviewed label Feb 3, 2025

parthaa marked this pull request as draft February 3, 2025 19:39

parthaa force-pushed the upgrade branch from fd162bd to dfaf5c4 Compare February 3, 2025 21:46

Docs to upgrade disconnected foreman/sat

3d347e6

Updates the instructions to upgrade 'in-place' for disconnected environments.

parthaa force-pushed the upgrade branch from dfaf5c4 to 3d347e6 Compare February 3, 2025 21:52

Lennonka added tech review done No issues from the technical perspective and removed Needs tech review Requires a review from the technical perspective labels Feb 5, 2025

Lennonka reviewed Feb 5, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docs to upgrade disconnected foreman/sat #3636

Docs to upgrade disconnected foreman/sat #3636

parthaa commented Feb 3, 2025 •

edited

Loading

github-actions bot commented Feb 3, 2025 •

edited

Loading

jeremylenz Feb 3, 2025

chris1984 Feb 3, 2025

jeremylenz Feb 3, 2025

jeremylenz Feb 3, 2025

jeremylenz Feb 3, 2025

chris1984 commented Feb 3, 2025

Lennonka left a comment

Lennonka Feb 5, 2025

Lennonka Feb 5, 2025

Lennonka Feb 5, 2025

Lennonka Feb 5, 2025

Lennonka Feb 5, 2025

	baseurl=file:///<baseos location>/content/dist/rhel8/8/x86_64/baseos/os
	baseurl=file:///<baseos location>/content/dist/rhel9/9/x86_64/baseos/os

	baseurl=file:///<appstream location>/content/dist/rhel8/8/x86_64/appstream/os
	baseurl=file:///<appstream location>/content/dist/rhel9/9/x86_64/appstream/os

	baseurl=file:///<foreman location>/content/dist/layered/rhel8/x86_64/satellite/6.15/os/
	baseurl=file:///<foreman location>/content/dist/layered/rhel9/x86_64/satellite/6.17/os/

	[options="nowrap" subs="+quotes"]
	[options="nowrap" subs="+quotes,attributes"]

Docs to upgrade disconnected foreman/sat #3636

Are you sure you want to change the base?

Docs to upgrade disconnected foreman/sat #3636

Conversation

parthaa commented Feb 3, 2025 • edited Loading

What changes are you introducing?

Why are you introducing these changes? (Explanation, links to references, issues, etc.)

Anything else to add? (Considerations, potential downsides, alternative solutions you have explored, etc.)

Checklists

github-actions bot commented Feb 3, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chris1984 commented Feb 3, 2025

Lennonka left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

parthaa commented Feb 3, 2025 •

edited

Loading

github-actions bot commented Feb 3, 2025 •

edited

Loading