Uploaded image for project: 'Satellite'
  1. Satellite
  2. SAT-34024

[Doc] Promote Ansible Module Collection as a management tool for Satellite

XMLWordPrintable

    • Icon: Story Story
    • Resolution: Done
    • Icon: Undefined Undefined
    • 6.18.0
    • None
    • Documentation
    • None
    • Enhancement
    • Hide
      .Improved documentation on using Satellite Ansible Collection

      Documentation on using modules from the Satellite Ansible Collection is updated and expanded. Satellite Ansible Collection is a set of Ansible modules that interact with the Satellite API. You can use the modules to automate many aspects of Satellite administration. See the new link:https://docs.redhat.com/en/documentation/red_hat_satellite/6.18/html-single/using_the_satellite_ansible_collection/index[Using the Satellite Ansible Collection] guide.
      Show
      .Improved documentation on using Satellite Ansible Collection Documentation on using modules from the Satellite Ansible Collection is updated and expanded. Satellite Ansible Collection is a set of Ansible modules that interact with the Satellite API. You can use the modules to automate many aspects of Satellite administration. See the new link: https://docs.redhat.com/en/documentation/red_hat_satellite/6.18/html-single/using_the_satellite_ansible_collection/index [Using the Satellite Ansible Collection] guide.
    • Done
    • None

      Mini Content Journey

      Who is your target persona?

      Satellite administrator

      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 learn about Satellite's Ansible Module Collection as a tool for Satellite server management.

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

      1. Find the relevant documentation.
      2. Understand why Ansible Module Collection is useful.
      3. Start using the Ansible modules.

      (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 on Ansible Module Collection: https://docs.theforeman.org/3.14/Administering_Project/index-katello.html#managing-foreman-with-ansible

      Separate guides on other Satellite management tools: https://docs.theforeman.org/3.14/Hammer_CLI/index-katello.html and https://docs.theforeman.org/3.14/Project_API/index-katello.html

      People: (most likely not needed, this is mostly just about moving existing content to a new guide)

      • SME: [SME name]
      • QE: [QE name]

      Release Note: Yes

      Documentation Outline

      A new guide that mirrors the structure of Hammer CLI and Foreman API guides:

      • Overview/Introduction (concept)
      • Getting help for Ansible Module Collection (concept)
      • Installing Ansible Module Collection (procedure)
      • Using Ansible modules (procedure)
      • Usage examples (reference)

              apetrova@redhat.com Aneta Šteflová Petrová
              apetrova@redhat.com Aneta Šteflová Petrová
              Aneta Šteflová Petrová Aneta Šteflová Petrová
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

                Created:
                Updated:
                Resolved: