saltstack / saltstack/salt

[DOCS] No supporting documentation exists for use of http_proxy / https_proxy

Open
#63,069 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

doc-request documentation severity-medium time-estimate-long-term
Dominant language
Python
Stars
15.7k
Forks
5.6k
Avg merge
2d 44m
Merged PRs (30d)
80

Description

Description
Users particularly in air-gapped environments may require use of proxy servers, and no documentation exists to provide guidance in the usage of http_proxy or https_proxy settings to facilitate this.

Google searches for things like 'saltstack http proxy' return almost exclusively results for proxy minion behavior and are unlikely to locate the minion configuration page that contains the relevant opts.

Suggested Fix
Though minion configuration docs list the associated opts from minion perspective, there is no treatment of equivalent env vars http_proxy and https_proxy and their effect on minion and master behavior.

Type of documentation
Salt documentation

Location or format of documentation
https://docs.saltproject.io/en/latest/ref/configuration/minion.html
https://docs.saltproject.io/en/latest/ref/configuration/master.html

Additional context
See
https://github.com/saltstack/salt/pull/29322
https://github.com/saltstack/salt/issues/8177
[It is preposterously difficult to find reasonable documentation on use of http_proxy in env, but] https://www.cyberciti.biz/faq/linux-unix-set-proxy-environment-variable/

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

Start with the minion and master configuration pages named in the issue, then review pull request 29322 and issue 8177 for existing behavior and terminology. Document how http_proxy and https_proxy affect minion and master behavior, with guidance discoverable from both configuration pages.

Written by the indexing model from the issue text.

Assessment

Domain
devops, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.