saltstack / saltstack/salt

[DOCS] Pillar Encryption should mention shebang renderers

Open
#62,733 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation Pillar Renderers salt install guide severity-medium time-estimate-sprint
Dominant language
Python
Stars
15.7k
Forks
5.6k
Avg merge
2d 44m
Merged PRs (30d)
80

Description

Description
The documentation only mentions using decrypt_pillar in the master config to define the pillar paths to be decrypted.

Suggested Fix
It's often easier to manage by defining the renderers in the pillar .sls instead, e.g. #!jinja|yaml|gpg for the default.

Type of documentation
Salt documentation

Location or format of documentation
https://docs.saltproject.io/en/latest/topics/pillar/index.html#encrypted-pillar-sls

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 Salt documentation page at the encrypted-pillar-sls section and read how decrypt_pillar is currently described. Update that section to mention the pillar .sls shebang renderer syntax, including the documented example, and confirm the explanation is accurate and complete.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, security
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.