Document the Saltfile and clarify the --saltfile option (fixes #60210)#69238
Open
ggiesen wants to merge 1 commit into
Open
Document the Saltfile and clarify the --saltfile option (fixes #60210)#69238ggiesen wants to merge 1 commit into
ggiesen wants to merge 1 commit into
Conversation
The Saltfile docs only covered salt-ssh and never explained what a Saltfile actually is, which leads users to assume it is a configuration file rather than a way to supply command-line options (saltstack#60210). Rewrite the section to explain that a Saltfile supplies command-line options (not config-file settings) for any Salt CLI tool, document the search order (--saltfile, SALT_SALTFILE, ./Saltfile, ~/.salt/Saltfile), keep the option-dest naming note, add an external-auth example using the CLI option names rather than master-config keys, and note that Saltfile values currently take precedence over options passed on the command line. Expand the --saltfile help string to match.
Contributor
Author
|
Base rationale: targeting master, as this is a documentation change (clarifying what a Saltfile is and how |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Rewrites the "Define CLI Options with Saltfile" documentation and expands the
--saltfilehelp string so it is clear what a Saltfile is and how it works.The existing docs were framed as a salt-ssh-only feature and never explained what a Saltfile actually is, so users assumed it was a configuration file. The rewrite (same section, anchor preserved):
salt,salt-ssh,salt-call,salt-cloud,salt-key, ...).--saltfile, thenSALT_SALTFILE, then./Saltfile, then~/.salt/Saltfile.ssh_wipeexample.eauth,username,password) rather than master-config keys such asexternal_auth, which is a common point of confusion.Also expands the
--saltfilehelp string insalt/utils/parsers.pyto say it is a YAML file of command-line options (not a config file) and to list the full search order.What issues does this PR fix or reference?
Fixes #60210
Previous Behavior
Documentation only described Saltfile in a salt-ssh context, did not explain its purpose, omitted the
SALT_SALTFILEenv var and the full search order, and did not clarify that it supplies CLI options rather than configuration settings.New Behavior
Documentation-only change; no runtime behavior changes.
Merge requirements satisfied?
[NOTICE] Bug fixes or features added to Salt require tests.
Commits signed with GPG?
No