-
Bug
-
Resolution: Unresolved
-
Major
-
None
-
None
-
5
-
False
-
Sat_docs_4_2025
-
sat-rocket
-
None
-
None
-
None
-
No Coverage
Problem Statement
In the current Capsule upgrade documentation, there is no mention of backing up DNS and DHCP configuration files at the beginning. While the documentation does mention restoring these files at the end if manual changes were made, it would be more helpful to users if the backup instruction was included earlier in the process.
There are no instructions mentioned to back up these configuration files earlier in the documentation:
-------
13. Optional: If you made manual edits to DNS or DHCP configuration files, check and restore any changes required to the DNS and DHCP configuration files using the backups made earlier.
-------
In contrast, the Satellite upgrade documentation provides a clear instruction at the start of the process:
-------
4. Optional: If you made manual edits to DNS or DHCP configuration in the /etc/zones.conf or /etc/dhcp/dhcpd.conf files, back up the configuration files because the installer only supports one domain or subnet, and therefore restoring changes from these backups might be required.
-------
Additionally, it includes an optional step to avoid overwriting changes:
-------
5. Optional: If you made manual edits to DNS or DHCP configuration files and do not want to overwrite the changes, enter the following command:
satellite-installer --foreman-proxy-dns-managed=false \ --foreman-proxy-dhcp-managed=false
-------
There is currently an instruction to enable custom repositories at the end of the upgrade process. It would be helpful if there were instructions to check for custom repositories on both the Satellite and Capsule servers before the upgrade. This pre-check would make the process smoother and ensure that users are aware of which repositories need to be re-enabled later.
User Experience & Workflow
Making it more difficult for users to plan out upgrade change.
Requirements
1. The instruction to back up DNS and DHCP configuration files be added to the beginning of the Capsule upgrade section to provide clearer guidance for users. Additionally, if possible please include the optional step to avoid overwriting changes, as seen in the Satellite documentation.
2. Including a step in the upgrade helper to check for custom repositories on both the Satellite and Capsule servers before the upgrade can make the process smoother.
Business Impact