Split Administering hosts into multiple assemblies#4758
Split Administering hosts into multiple assemblies#4758aneta-petrova wants to merge 1 commit intotheforeman:masterfrom
Conversation
github-actions
bot
added
Needs tech review
|
The PR preview for 6a01de6 is available at theforeman-foreman-documentation-preview-pr-4758.surge.sh The following output files are affected by this PR:
|
aneta-petrova
force-pushed
the
ustory-administering-hosts
branch
from
b70be75 to
61922e5
Compare
aneta-petrova
removed
Needs tech review
Each assembly should describe a single user story only Assisted-by: Cursor
aneta-petrova
force-pushed
the
ustory-administering-hosts
branch
from
61922e5 to
6a01de6
Compare
maximiliankolb
left a comment
maximiliankolb
left a comment
There was a problem hiding this comment.
Great PR overall. I made some suggestions.
| = Managing host placement and associations | ||
|
|
||
| [role="_abstract"] | ||
| Use {Project} to link each host to a compute resource, organization, location, and content view environment. |
There was a problem hiding this comment.
This feels very vague to me.
What does "link" mean? You cannot just say "move host A from Azure to GCE". Instead, you'd have to redeploy it and delete the old one. That only works well if you have its configuration as code.
|
|
||
| [role="_abstract"] | ||
| Use {Project} to link each host to a compute resource, organization, location, and content view environment. | ||
| Detach host records when hosts move or retire so your host list stays current. |
There was a problem hiding this comment.
| Detach host records when hosts move or retire so your host list stays current. | |
| Detach host records when hosts move or retire so your host list stays current and {Project} no longer tries to manage it. |
Unsure about this too. Does detach mean unregister on the Client or mark as unassociated in Foreman/delete in Foreman?
| = Managing host snapshots | ||
|
|
||
| [role="_abstract"] | ||
| You can install the snapshot management plugin and create virtual machine snapshots from {Project} to capture a point-in-time state before risky changes. |
There was a problem hiding this comment.
| You can install the snapshot management plugin and create virtual machine snapshots from {Project} to capture a point-in-time state before risky changes. | |
| You can install the Snapshot Management plugin and create virtual machine snapshots from {Project} to capture a point-in-time state before risky changes. |
| [role="_abstract"] | ||
| You can review hosts in the {ProjectWebUI} to see them in one place and select the columns you need for daily work. | ||
| ifdef::katello,satellite,orcharhino[] | ||
| When {RHEL} lifecycle data is available, check it in the same views to plan patches and track compliance. |
There was a problem hiding this comment.
| When {RHEL} lifecycle data is available, check it in the same views to plan patches and track compliance. | |
| When {client-os} lifecycle data is available, check it in the same views to plan patches and track compliance. |
This affects all Clients.
|
|
||
| include::modules/con_configuring-tracer-and-application-restarts-on-hosts.adoc[] | ||
|
|
||
| ifdef::katello,orcharhino,satellite[] |
There was a problem hiding this comment.
I wonder if we should hide the whole assembly from foreman-el/foreman-deb? Is the concept module on its own of any value?
|
This might be out of scope for this PR, but it would be great if we could move 20. Host status in Foreman under the first chapter Reviewing hosts... Just for your consideration :) |
3 participants
What changes are you introducing?
Introducing several smaller, focused assemblies in place of the existing catch-all "Administering hosts" assembly.
Why are you introducing these changes? (Explanation, links to references, issues, etc.)
Each assembly should cover a single user story (this is part of the downstream Content Quality Assessment (CQA) initiative.)
Anything else to add? (Considerations, potential downsides, alternative solutions you have explored, etc.)
I'm not changing anything about the modules themselves, I'm just moving them around.
I used the skill from #4723 for a first draft and I'd say it got about half of the changes right on the first try, so it did a lot of heavy lifting for me, which was very useful.
Contributor checklists
Please cherry-pick my commits into: