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] Review highstate outputter docs and state_output docs option #59166

Open
ScriptAutomate opened this issue Dec 18, 2020 · 0 comments
Open
Labels
doc-rst-update .rst file edits docstring-update string edits Documentation Relates to Salt documentation module doc standards severity-medium 3rd level, incorrect or bad functionality, confusing and lacks a work around time-estimate-sprint
Projects
Milestone

Comments

@ScriptAutomate
Copy link
Contributor

Description

The highstate outputter salt/output/highstate.py provides conflicting information about state_output when compared to the minion and master config option documentation.

Suggested Fix

  • If extra potential values exist, such as filter, then the minion/master config documentation needs to be updated.
  • Evaluate whether state_output_diff and state_output_profile need to be included in the docstring documentation found in salt/output/highstate.py

Type of documentation

  • Salt documentation

Location or format of documentation

state_output:
The highstate outputter has six output modes,
``full``, ``terse``, ``mixed``, ``changes`` and ``filter``
* The default is set to ``full``, which will display many lines of detailed
information for each executed chunk.
* If ``terse`` is used, then the output is greatly simplified and shown in
only one line.
* If ``mixed`` is used, then terse output will be used unless a state
failed, in which case full output will be used.
* If ``changes`` is used, then terse output will be used if there was no
error and no changes, otherwise full output will be used.
* If ``filter`` is used, then either or both of two different filters can be
used: ``exclude`` or ``terse``.
* for ``exclude``, state.highstate expects a list of states to be excluded (or ``None``)
followed by ``True`` for terse output or ``False`` for regular output.
Because of parsing nuances, if only one of these is used, it must still
contain a comma. For instance: `exclude=True,`.
* for ``terse``, state.highstate expects simply ``True`` or ``False``.
These can be set as such from the command line, or in the Salt config as
`state_output_exclude` or `state_output_terse`, respectively.
The output modes have one modifier:
``full_id``, ``terse_id``, ``mixed_id``, ``changes_id`` and ``filter_id``
If ``_id`` is used, then the corresponding form will be used, but the value for ``name``
will be drawn from the state ID. This is useful for cases where the name
value might be very long and hard to read.

vs.

salt/conf/master

Lines 625 to 631 in 318502a

# The state_output setting controls which results will be output full multi line
# full, terse - each state will be full/terse
# mixed - only states with errors will be full
# changes - states with changes and errors will be full
# full_id, mixed_id, changes_id and terse_id are also allowed;
# when set, the state ID will be used as name in the output
#state_output: full

salt/conf/minion

Lines 695 to 701 in 318502a

# The state_output setting controls which results will be output full multi line
# full, terse - each state will be full/terse
# mixed - only states with errors will be full
# changes - states with changes and errors will be full
# full_id, mixed_id, changes_id and terse_id are also allowed;
# when set, the state ID will be used as name in the output
#state_output: full

Additional context

Potentially related or of interest: #51090

@ScriptAutomate ScriptAutomate added Documentation Relates to Salt documentation docstring-update string edits doc-rst-update .rst file edits labels Dec 18, 2020
@sagetherage sagetherage added this to the Approved milestone Feb 11, 2021
@sagetherage sagetherage added this to To do in Salt Docs Mar 23, 2021
@ScriptAutomate ScriptAutomate removed their assignment Sep 30, 2021
@barbaricyawps barbaricyawps added severity-medium 3rd level, incorrect or bad functionality, confusing and lacks a work around time-estimate-sprint and removed needs-triage labels Jan 12, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc-rst-update .rst file edits docstring-update string edits Documentation Relates to Salt documentation module doc standards severity-medium 3rd level, incorrect or bad functionality, confusing and lacks a work around time-estimate-sprint
Projects
Salt Docs
  
To do
Development

No branches or pull requests

3 participants