search

theforeman / foreman-documentation

Documentation for the Foreman Project and its ecosystem
https://docs.theforeman.org
Creative Commons Attribution Share Alike 4.0 International
22 stars 95 forks source link

Opt in to RH insights #3288

Closed maximiliankolb closed 1 month ago

maximiliankolb commented 2 months ago

What changes are you introducing?

add procedure to opt-in to uploading reports to RH cloud.

Why are you introducing these changes? (Explanation, links to references, issues, etc.)

on orcharhino, users register hosts with RHEL and non-RHEL OS, but they should only set the parameter for RHEL OS.

Anything else to add? (Considerations, potential downsides, alternative solutions you have explored, etc.)

Checklists

Please cherry-pick my commits into:

github-actions[bot] commented 2 months ago

The PR preview for c3d985939a3fc95fdd832f7020895d1a6408725c is available at theforeman-foreman-documentation-preview-pr-3288.surge.sh

The following output files are affected by this PR:

show diff

show diff as HTML

ekohl commented 2 months ago

In general, I question the hint about all the levels to set the parameter. If we mentation "yes, you can set it globally/for this subnet", then we do not really focus on the fact that it's supposed to differ on an per-OS level, namely RHEL and non-RHEL OS.

To me it feels a bit redundant if you understand how host parameters work. I don't know if we have a documentation section on it. I don't think we do, but IMHO we should have something like that. Then you can refer to it.

maximiliankolb commented 2 months ago

In general, I question the hint about all the levels to set the parameter. If we mentation "yes, you can set it globally/for this subnet", then we do not really focus on the fact that it's supposed to differ on an per-OS level, namely RHEL and non-RHEL OS.

To me it feels a bit redundant if you understand how host parameters work. I don't know if we have a documentation section on it. I don't think we do, but IMHO we should have something like that. Then you can refer to it.

We have a list in the Provisioning Hosts guide: https://docs.theforeman.org/nightly/Provisioning_Hosts/index-katello.html#Host_Parameter_Hierarchy_provisioning

@ekohl Are you OK with removing the sentence about "you can also set this on level X" in both procedures and instead refer users to this reference?

ekohl commented 2 months ago

@ekohl Are you OK with removing the sentence about "you can also set this on level X" in both procedures and instead refer users to this reference?

Yes, that's what I was looking for.

I do see it says:

You can access host parameters when provisioning hosts

Host parameters are indeed used when provisioning hosts, but also in other cases. The ENC as used by Puppet comes to mind, but also REX and here with RH cloud.

Perhaps you can broaden that sentence?

Edit: I was looking for this in the Administrating hosts guide and couldn't find it. Perhaps out of scope for this PR, but should it be moved?

maximiliankolb commented 1 month ago

Merged to "master" and cherry-picked: bd9d5c75db..1f88c99a2a 3.12 -> 3.12 195905513e..0373afcb6d 3.11 -> 3.11