foreman-documentation icon indicating copy to clipboard operation
foreman-documentation copied to clipboard

Fix backup instructions for non-Katello

Open ekohl opened this issue 3 years ago • 2 comments

Not a blocker for this, but I don't think we have an instruction to install foreman-maintain anywhere.

Also, for the estimating the backup size the paths are a bit off. I have https://github.com/theforeman/foreman-documentation/pull/1825 which would fix it for the PG part. Then we also have katello-specific paths there which should also be removed from foreman-el.

On a related note: I don't get the math in the example. How does it get to 681 GB?

The chapter 6.3. Performing a Backup without Pulp Content should be skipped on non-Katello.

6.6. Performing an Online Backup does talk about Pulp a lot. I also wonder how much of that is still true with Pulp 3.

6.7. Performing a Snapshot Backup also talks about Pulp a lot.

7.3. Backup and Restore Smart Proxy server Using a Virtual Machine Snapshot also has this:

If required, deploy a new Smart Proxy server, ensuring the host name is the same as before, and then install the Smart Proxy certificates. You may still have them on Foreman server, the package name ends in -certs.tar, alternately create new ones.

That is also Katello-only.

I don't consider the Katello-isms as a blocker, since the foreman-el guide is already showing the invalid instructions, but we shouldn't forget about it.

Originally posted by @ekohl in https://github.com/theforeman/foreman-documentation/pull/1864#pullrequestreview-1206385197

ekohl avatar Dec 07 '22 16:12 ekohl

https://github.com/theforeman/foreman-documentation/issues/693 was already open, but I think this is easier to act on so keeping this open.

ekohl avatar Mar 06 '23 13:03 ekohl

@ekohl Please update.

apinnick avatar Aug 08 '24 11:08 apinnick

The chapter 6.3. Performing a Backup without Pulp Content should be skipped on non-Katello.

Done: https://docs.theforeman.org/nightly/Administering_Project/index-katello.html#Performing_a_Backup_Without_Pulp_Content_admin is shown, but https://docs.theforeman.org/nightly/Administering_Project/index-foreman-deb.html#backing-up-foreman-server-and-smart-proxy_admin doesn't have it.

6.6. Performing an Online Backup does talk about Pulp a lot. I also wonder how much of that is still true with Pulp 3.

Done: https://docs.theforeman.org/nightly/Administering_Project/index-katello.html#Performing_an_Online_Backup_admin vs https://docs.theforeman.org/nightly/Administering_Project/index-foreman-deb.html#Performing_an_Online_Backup_admin looks good to me

6.7. Performing a Snapshot Backup also talks about Pulp a lot.

Done: this whole concept is no longer supported and thus dropped

7.3. Backup and Restore Smart Proxy server Using a Virtual Machine Snapshot also has this:

https://docs.theforeman.org/nightly/Administering_Project/index-katello.html#backup-and-restore-smart-proxy-server-by-using-a-virtual-machine-snapshot vs https://docs.theforeman.org/nightly/Administering_Project/index-foreman-deb.html#backup-and-restore-smart-proxy-server-by-using-a-virtual-machine-snapshot

Here we see one issue:

If required, deploy a new Smart Proxy server, ensuring the host name is the same as before, and then install the Smart Proxy certificates. You may still have them on Foreman server, the package name ends in -certs.tar, alternately create new ones. Follow the procedures in Installing Smart Proxy server until you can confirm, in the Foreman web UI, that Smart Proxy server is connected to Foreman server.

In particular this bit:

You may still have them on Foreman server, the package name ends in -certs.tar, alternately create new ones.

That -certs.tar file is a Katello specific thing. It's probably easiest to drop that part of the sentence:

You may still have them, alternately create new ones.

Submitted as https://github.com/theforeman/foreman-documentation/pull/4007.

ekohl avatar Jul 14 '25 16:07 ekohl