saltstack / saltstack/salt

[DOCS] Beacon inotify install instructions do not work

Open
#63,693 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Beacon documentation severity-high time-estimate-sprint
Dominant language
Python
Stars
15.7k
Forks
5.6k
Avg merge
2d 44m
Merged PRs (30d)
80

Description

Description
The Beacon inotify install instructions do not work

According to the documentation, inotify can be installed by running

salt myminion pkg.install python-inotify

but this causes the following error to show up in the systemctl logs:

$ sudo systemctl status salt-minion
...
Feb 09 20:20:39 ip-10-0-0-248 salt-minion[1319]: [WARNING ] No validate function found for inotify, running basic beacon validation.
Feb 09 20:20:39 ip-10-0-0-248 salt-minion[1319]: [WARNING ] Unable to process beacon inotify
Feb 09 20:20:40 ip-10-0-0-248 salt-minion[1319]: [WARNING ] No validate function found for inotify, running basic beacon validation.
Feb 09 20:20:40 ip-10-0-0-248 salt-minion[1319]: [WARNING ] Unable to process beacon inotify

I have tried installing it by running

sudo salt '*' pip.install python-inotify

but then I receive the following error

ip-10-0-0-248:
    ----------
    pid:
        1602
    retcode:
        1
    stderr:
        ERROR: Could not find a version that satisfies the requirement python-inotify (from versions: 0.6-test, 0.6-test.linux-x86_64)
        ERROR: No matching distribution found for python-inotify
    stdout:

What is the proper way to install this?

Suggested Fix
Update the documentation to include how to properly install the python-inotify package

Type of documentation
Salt documentation

Location or format of documentation
https://docs.saltproject.io/en/latest/topics/beacons/index.html#id2

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

Start with the Beacon inotify section at the linked documentation URL and compare its python-inotify installation command with the reported systemctl and pip errors. Determine the proper package installation method, update that section with the working instructions, and verify that the documented steps no longer produce the reported failure.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.