Fixes #615 - Add documentation for update procedure#616
Conversation
|
@qcjames53 General note -- if you are planning to open a PR, a github issue is not required to track the PR. I would file issues if you want to report or request something that won't be implemented for a while or if multiple PRs will be required to achieve it. |
|
|
||
| - 1.2.z+ -> Foreman 3.17 | ||
| - 2.0.z -> Foreman 3.18 | ||
| - 2.2.z+ -> Foreman 3.19 |
There was a problem hiding this comment.
I'm not sure we should try and state this here. As this might be true right now, but it also might change and then we have to come update this file.
| - 2.0.z -> Foreman 3.18 | ||
| - 2.2.z+ -> Foreman 3.19 | ||
|
|
||
| TODO: This table needs an explanation for the Y stream schema. Ask Evgeni or Ewoud about this. Add a resource where users can match a Foreman version to a foremanctl version. |
There was a problem hiding this comment.
This assumes we intend users to use it from git for production rather than the RPM. That's a design question we haven't tried to answer.
| 3. Begin the upgrade by stopping all Foreman processes with `systemctl stop foreman.target`. | ||
| 4. Upgrade foremanctl using dnf: | ||
| - Upgrade to latest version (or latest allowed by versionlock): `dnf upgrade foremanctl` | ||
| - Upgrade to specific version: `dnf upgrade foremanctl-X.Y.Z` |
There was a problem hiding this comment.
I don' think we should call this out.
| - `dnf versionlock add 'foremanctl-X.Y.*'` - Lock upgrades to a certain Y-stream (replace with exact X.Y version). | ||
| - `dnf versionlock delete foremanctl` - Remove any foremanctl versionlock. | ||
| 2. We recommend a full foremanctl backup before all upgrade operations. Run `foremanctl backup <filepath for backup>`. Please see [Backup](backup.md) for more information on this process. | ||
| 3. Begin the upgrade by stopping all Foreman processes with `systemctl stop foreman.target`. |
There was a problem hiding this comment.
Should the user run health check before this?
|
|
||
|
|
||
|
|
||
| ## Upgrading from source |
There was a problem hiding this comment.
For now, I would put this in the developer documentation and not "user".
2 participants
Why are you introducing these changes? (Problem description, related links)
#615
What are the changes introduced in this pull request?
Note: this pull request has a few TODOs which are open questions that need to be answered by the foremanctl team. Please feel free to push to this branch to address these issues (no AI fluff please). I'll try to keep an eye on this during my paternity leave if I have any time 🤞
How to test this pull request
Checklist