[DOCS] ESXi proxy minion docs missing authentication options
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 15.7k
- Forks
- 5.6k
- Avg merge
- 2d 44m
- Merged PRs (30d)
- 80
Description
Description
The ESXi proxy minion docs located here: https://docs.saltproject.io/en/latest/ref/proxy/all/salt.proxy.esxi.html and the tutorial docs located here: https://docs.saltproject.io/en/latest/topics/tutorials/esxi_proxy_minion.html are missing documentation of the options for connecting via a vCenter server, including vcenter, esxi_host, mechanism, and principal (if mechanism=sspi)
Suggested Fix
At a minimum update the proxy module docs to include those parameters.
Type of documentation
Salt modules and Tutorial
Location or format of documentation
https://docs.saltproject.io/en/latest/ref/proxy/all/salt.proxy.esxi.html
https://docs.saltproject.io/en/latest/topics/tutorials/esxi_proxy_minion.html
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the ESXi proxy module documentation and tutorial at the two URLs in the issue, then read the referenced sections of salt/proxy/esxi.py for vcenter, esxi_host, mechanism, domain, and principal. Update both documentation locations so these connection options and the SSPI principal requirement are covered; the task is done when the proxy module reference and tutorial describe all requested parameters.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation, infrastructure
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 50/100