hashi_vault - add retries option to allow for retrying failed requests

[briantist]

SUMMARY

Closes #58

Adds retries option which enables retrying failed requests with urllib3.Retry.

Also adds retry_action to control whether or not to emit warnings when a request is retried.

This PR also adds the start of a collection docsite, with a User Guide that goes into detail on the retry support.

ISSUE TYPE

• Feature Pull Request

COMPONENT NAME

hashi_vault

ADDITIONAL INFORMATION

[codecov]

Codecov Report

Merging #71 (fe27f07) into main (d597e13) will increase coverage by 0.50%.
The diff coverage is 88.28%.

@@            Coverage Diff             @@
##             main      #71      +/-   ##
==========================================
+ Coverage   83.01%   83.52%   +0.50%     
==========================================
  Files          16       16              
  Lines         789      892     +103     
  Branches       78       87       +9     
==========================================
+ Hits          655      745      +90     
- Misses        120      129       +9     
- Partials       14       18       +4     

Impacted Files	Coverage Δ
plugins/doc_fragments/connection.py	100.00% <ø> (ø)
plugins/lookup/hashi_vault.py	63.84% <ø> (ø)
plugins/module_utils/_hashi_vault_common.py	93.61% <80.95%> (-6.39%)	⬇️
plugins/plugin_utils/_hashi_vault_plugin.py	58.82% <87.50%> (+6.97%)	⬆️
...odule_utils/test_hashi_vault_connection_options.py	100.00% <100.00%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d597e13...fe27f07. Read the comment docs.

[felixfontein]

You probably want to run pip install antsibull && antsibull-lint collection-docs . in a new workflow to add basic linting for the docs.

(I only looked at the documentation.)

[briantist]

It looks I've gotten about all the review I'm gonna get on this one. In addition to tests added here, I've run other local manual tests. I learned some things with that, that I hope to port over to CI at some point, but it's going to require some more of the test improvement work to be done. It's pretty exciting nonetheless, looking at using MMock to support some advanced testing scenarios that are going to be difficult with a real Vault server alone (intermittent failing connections, maybe AWS/Azure/GCP/etc. backend testing without setting up the actual backend 3rd party service, etc.) by mocking various endpoints.

In the meantime, I'll merge this is in so we can get it released.