Who is your target persona?

Administrator managing Satellite with Ansible

What stage of the user journey are you targeting?

Adopt, Expand

Why is this content important?

Ease of use for Satellite Ansible features. More support for Ansible features is requested in https://issues.redhat.com/browse/SAT-20657

What is the main user goal aka job to be done?

As a Satellite administrator, I want to leverage Satellite's Ansible modules to be able to manage Satellite in an automated way so that I can reduce my maintenance overhead.

Substory (which originated in https://issues.redhat.com/browse/SAT-31859): As a Satellite administrator, I want to leverage Kerberos authentication when using Satellite's Ansible Modules so that I can authenticate with a Kerberos ticket rather than username/password.

What high level steps does the user need to take to accomplish the goal?

1. Install modules (https://docs.theforeman.org/nightly/Administering_Project/index-satellite.html#Installing_the_Project_Ansible_Modules_admin )
2. Authenticate (currently undocumented but https://issues.redhat.com/browse/SAT-31859 adds Kerberos authentication for IdM users in addition to existing username/password option)
3. Look at examples of usage
4. Try using an Ansible module
5. Look at Ansible module reference

(Optional) What is the general sentiment of users towards this goal?

(Optional) What pain points are the user likely to encounter when accomplishing this goal?

(Optional) What other feedback do users have around this goal?

(Optional) Are there any additional opportunities you can also implement for the user when documenting this goal?

Links to existing content 

Existing documentation that is insufficient to cover the end-to-end workflow: Managing Satellite with Ansible https://docs.theforeman.org/nightly/Administering_Project/index-satellite.html#managing-satellite-with-ansible

The new documentation could follow the same structure and has a similar use case as: Hammer CLI https://docs.theforeman.org/nightly/Hammer_CLI/index-satellite.html

People:

• SME: Evgeni Golov
• QE: Radek Mynář

Release Note: No

Documentation Outline

• Introduction/overview to Ansible modules (use case explanation and how it differs from the Ansible guide on managing hosts: https://docs.theforeman.org/nightly/Managing_Configurations_Ansible/index-satellite.html ) (Concept)
• Authenticating (Procedure)
• Usage example (Procedure or reference)
• Available Ansible modules (reference, similar to https://docs.theforeman.org/nightly/Administering_Project/index-satellite.html#Viewing_the_Ansible_Modules_admin )