Fixes #615 - Add documentation for update procedure#621
Conversation
- Moved Upgrading from source section into developer docs - Added recommendation for running health check before upgrading foremanctl
| - 1.2.z+ -> Foreman 3.17 | ||
| - 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.
@ehelms on the previous PR you mentioned "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."
Does it make sense to leave this part out or maybe move this into the developer docs since the rest of this doc assumes installing/upgrading from RPM.
|
Based on previous comments on #616. I added the health check mention in |
|
|
||
| In a source install, git branches control versioning instead of RPM packages. Stable branches (e.g. `2.y-stable`) track a specific Foreman Y-stream, while the `master` branch tracks nightly changes (most recent). | ||
|
|
||
| All below steps must be run as root user. |
There was a problem hiding this comment.
| All below steps must be run as root user. | |
| All steps must be run as the root user. |
|
|
||
| All below steps must be run as root user. | ||
|
|
||
| 1. Please take a moment to determine your preferred Foreman version / git branch. Cross-reference with the Foreman version table above. |
There was a problem hiding this comment.
This makes it sound like the user can upgrade from any version to any other version, which we do not test.
|
|
||
| ### Upgrading from source | ||
|
|
||
| In a source install, git branches control versioning instead of RPM packages. Stable branches (e.g. `2.y-stable`) track a specific Foreman Y-stream, while the `master` branch tracks nightly changes (most recent). |
There was a problem hiding this comment.
This procedure needs to be specific about where foremanctl is being run from since from a git checkout you can run it from your Laptop pointed at a VM. Or you can run it from a git checkout on the VM.
3 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). This PR was originally opened #616. The author (@qcjames53) is on paternity leave. This PR will replace the existing PR.
How to test this pull request
Checklist