[3007.x] [DOCS] Refresh gitfs/git_pillar/s3fs/file_roots docs#69566
Draft
dwoz wants to merge 1 commit into
Draft
[3007.x] [DOCS] Refresh gitfs/git_pillar/s3fs/file_roots docs#69566dwoz wants to merge 1 commit into
dwoz wants to merge 1 commit into
Conversation
* gitfs walkthrough: drop EOL Ubuntu 14/Debian Wheezy/CentOS 7.3 notes and pin pygit2>=1.13.1, GitPython>=3.1.50 (matches base.txt + CI lockfiles). Adds a GitLab subsection covering deploy tokens, project access tokens, PATs, and SSH deploy keys. * git_pillar docstring: enumerate supported remote URL forms (https://, ssh://, scp-style user@host:path, file://). The scp-style colon is the most common source of 'Failed to resolve address' errors. * s3fs docstring: document s3.location / s3.service_url / s3.https_enable / s3.path_style / s3.verify_ssl with a Regional endpoints section, citing the SigV4 redirect failure mode. * file_roots.rst: new section explaining why /srv/salt is the default. Update netconfig/napalm_network examples to use /srv/salt instead of /etc/salt/states so the example matches the recommendation. * New tests: tests/pytests/functional/fileserver/gitfs/ test_documented_providers.py and tests/pytests/unit/fileserver/test_s3fs_documented_options.py pin the docs to the loader. Closes saltstack#62260 Closes saltstack#56127 Closes saltstack#60809 Closes saltstack#60408 Closes saltstack#53746
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
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.
Summary
Refresh of the gitfs / git_pillar / s3fs / file_roots docs to address five
long-standing documentation issues:
Wheezy, RHEL/CentOS 7.3-era CFFI quirks) and pins the recommended
dependency versions to what
requirements/base.txtand the CI lockfilesalready require (pygit2
>= 1.13.1/>= 1.19.2on py3.11+, GitPython>= 3.1.50). Salts internalGITPYTHON_MINVER/PYGIT2_MINVERfloorsare unchanged.
git_pillarexternal pillar: enumerates the supported remoteURL forms (https, ssh://, scp-style
user@host:path, file://) and callsout the scp-style colon as the most common source of "Failed to resolve
address" / "Unable to exchange encryption keys" errors at master start.
section of the walkthrough covering deploy tokens, project access
tokens, personal access tokens, and SSH deploy keys, plus the 401
failure mode for expired or under-scoped tokens.
the
s3fs.pymodule docstring documentings3.location,s3.service_url,s3.https_enable,s3.path_style, ands3.verify_sslwith the SigV4 redirect failure mode.
file_rootslocation: new "Where shouldfile_rootslive?"section explaining the
/srv/saltdefault. Updates thenetconfig.managedandnapalm_networkdocstring examples to use/srv/saltso the inline example matches the recommendation.Test plan
sphinx-build -W --keep-going -b htmlclean (no new warnings)sphinx-build -W --keep-going -b mancleanpre-commit runon all modified filespytest tests/pytests/functional/fileserver/gitfs/test_documented_providers.py(7 passed)pytest tests/pytests/unit/fileserver/test_s3fs_documented_options.py(6 passed) — 3006.x / 3007.x onlyCloses #62260
Closes #56127
Closes #60809
Closes #60408
Closes #53746