saltstack / saltstack/salt

[DOCS] Add info in ansible modules about requirements for new ansible-core

Open
#66,639 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation needs-triage
Dominant language
Python
Stars
15.7k
Forks
5.6k
Avg merge
2d 44m
Merged PRs (30d)
80

Description

Description
The ansible module does not work with ansible-core due ansible-core, being a minimal installation, it does not include the json outputter required by Salt to parse the output from the module execution

The fix is simple, install the plugin ansible.posix which includes the json outputter

$ ansible-galaxy collection install ansible.posix

Suggested Fix
Add this information to the ansible execution and state modules documentation

Type of documentation
Salt modules

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open the documentation for the Ansible execution and state modules and identify where their Ansible requirements are described. Verify the stated ansible.posix installation command, then document the json outputter requirement in both relevant sections. Done means users of ansible-core can find the prerequisite and installation command for each module type.

Written by the indexing model from the issue text.

Assessment

Tech stack
ansible
Domain
devops, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.