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

Document CLI, Ansible, and API for registering a host #3329

Closed asteflova closed 1 month ago

asteflova commented 2 months ago

What changes are you introducing?

I'm describing alternative ways of registering a host: CLI, Ansible, API.

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

https://issues.redhat.com/browse/SAT-28377 requested adding the Hammer command and API resource that correspond to the existing web UI procedure as users weren't aware of their existence and were unable to look them up. Then on top of that, prompted by a conversation with @evgeni, I thought it might be a good idea to add a reference to the corresponding Ansible module too.

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

The CLI, Ansible, and API "procedures" are very minimal by design. Users have very good reference documentation available to them (--help, ansible-doc, and built-in API reference) and I don't want to duplicate it in the guides.

I'm requesting cherry-picks down to 3.7 only because that's what https://github.com/theforeman/foreman-documentation/pull/3143, which targets the same procedure, did.

Checklists

Please cherry-pick my commits into:

github-actions[bot] commented 2 months ago

The PR preview for 8942746bf6e9f04887271afd6875b08b76959ffc is available at theforeman-foreman-documentation-preview-pr-3329.surge.sh

The following output files are affected by this PR:

show diff

show diff as HTML

asteflova commented 1 month ago

Merged to "master" and cherry-picked:

ab14f726a4..4bede6f080 3.12 -> 3.12 78b3649c58..5bc6dc0d87 3.11 -> 3.11 19ffe82ae7..dd9eb21688 3.10 -> 3.10 9f422ec1b0..ee9d962b71 3.9 -> 3.9 b2c6277a88..8f8e5ea4e5 3.8 -> 3.8 a4f55fb7ca..b584901b73 3.7 -> 3.7