Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] aptpkg.held state does not exist #61886

Open
reedacus25 opened this issue Mar 30, 2022 · 1 comment
Open

[DOCS] aptpkg.held state does not exist #61886

reedacus25 opened this issue Mar 30, 2022 · 1 comment
Labels
doc-correction docu page has an error or deadlink Documentation Relates to Salt documentation good first issue good for someone new to salt help-wanted Community help is needed to resolve this severity-medium 3rd level, incorrect or bad functionality, confusing and lacks a work around time-estimate-single-day
Milestone

Comments

@reedacus25
Copy link

reedacus25 commented Mar 30, 2022

Description
I tried to use the state aptpkg.held as shown in the documentation, only for that state to apparently not exist.

I tried looping through state modules such as apt, pkg, and aptpkg with hold and held states, to find apt.held as the actually correct usage.

$ for major in apt pkg aptpkg ; do for minor in hold held ; do salt 'minion' state.single $major.$minor name=salt-minion ; done ; done
minion:
    Data failed to compile:
----------
    Specified state 'apt.hold' was not found
ERROR: Minions returned with non-zero exit code
minion:
----------
          ID: salt-minion
    Function: apt.held
      Result: True
     Comment: Package salt-minion is already held
     Started: 17:21:33.289213
    Duration: 21.015 ms
     Changes:

Summary for minion
------------
Succeeded: 1
Failed:    0
------------
Total states run:     1
Total run time:  21.015 ms
minion:
    Data failed to compile:
----------
    Specified state 'pkg.hold' was not found
ERROR: Minions returned with non-zero exit code
minion:
    Data failed to compile:
----------
    Specified state 'pkg.held' was not found
ERROR: Minions returned with non-zero exit code
minion:
    Data failed to compile:
----------
    Specified state 'aptpkg.hold' was not found
ERROR: Minions returned with non-zero exit code
minion:
    Data failed to compile:
----------
    Specified state 'aptpkg.held' was not found
ERROR: Minions returned with non-zero exit code

Suggested Fix
The documentation should be changed to be salt.states.apt instead of salt.states.aptpkg since salt.states.aptpkg.held is not a valid state.

Type of documentation
State module documentation.

Location or format of documentation
Insert page URL if applicable.

Additional context
Appears to impact at least 3004.0 and 3004.1, not sure if 3003 and earlier.
Using Ubuntu 20.04 for testing.

@reedacus25 reedacus25 added Documentation Relates to Salt documentation needs-triage labels Mar 30, 2022
@welcome
Copy link

welcome bot commented Mar 30, 2022

Hi there! Welcome to the Salt Community! Thank you for making your first contribution. We have a lengthy process for issues and PRs. Someone from the Core Team will follow up as soon as possible. In the meantime, here’s some information that may help as you continue your Salt journey.
Please be sure to review our Code of Conduct. Also, check out some of our community resources including:

There are lots of ways to get involved in our community. Every month, there are around a dozen opportunities to meet with other contributors and the Salt Core team and collaborate in real time. The best way to keep track is by subscribing to the Salt Community Events Calendar.
If you have additional questions, email us at [email protected]. We’re glad you’ve joined our community and look forward to doing awesome things with you!

@OrangeDog OrangeDog added doc-correction docu page has an error or deadlink and removed needs-triage labels Mar 30, 2022
@OrangeDog OrangeDog added this to the Approved milestone Mar 30, 2022
@barbaricyawps barbaricyawps added help-wanted Community help is needed to resolve this good first issue good for someone new to salt time-estimate-single-day severity-medium 3rd level, incorrect or bad functionality, confusing and lacks a work around labels Apr 11, 2022
@parthdt parthdt mentioned this issue Oct 27, 2022
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc-correction docu page has an error or deadlink Documentation Relates to Salt documentation good first issue good for someone new to salt help-wanted Community help is needed to resolve this severity-medium 3rd level, incorrect or bad functionality, confusing and lacks a work around time-estimate-single-day
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants