saltstack / saltstack/salt

[DOCS] Homedir path in SALT.RENDERERS.GPG (ENCRYPTING DATA) are missing in few examples - bash/awk/perl

Open
#65,682 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Python
Stars
15.7k
Forks
5.6k
Avg merge
2d 44m
Merged PRs (30d)
80

Description

Description
In order to encrypt data homedir path must be set to /etc/salt/gpgkeys
echo -n 'supersecret' | gpg --trust-model always -ear - gpg: [stdin]: encryption failed: No public key should be the error if there is no gpg keys in user home dir.

Suggested Fix

To add missing homedir path "--homedir /etc/salt/gpgkeys" to all commands below:

echo -n 'supersecret' | gpg --homedir /etc/salt/gpgkeys --trust-model always -ear

awk

ciphertext=echo -n "supersecret" | gpg **--homedir /etc/salt/gpgkeys** --armor --batch --trust-model always --encrypt -r user@domain.com | awk '{printf "%s\\n",$0} END {print ""}'

Perl

ciphertext=echo -n "supersecret" | gpg **--homedir /etc/salt/gpgkeys** --armor --batch --trust-model always --encrypt -r user@domain.com | perl -pe 's/\n/\\n/g'

Type of documentation
Salt documentation

Location or format of documentation
Insert page URL if applicable.

Additional context
Add any other context or screenshots about the feature request here.

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 ref/renderers/all/salt.renderers.gpg.html and review the encryption examples for the basic, awk, and Perl commands. Confirm that each command includes --homedir /etc/salt/gpgkeys, then check the rendered page to ensure the examples consistently show the required key-directory path.

Written by the indexing model from the issue text.

Assessment

Tech stack
awk, bash, perl
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.