ansible-collections / community.hashi_vault

Ansible collection for managing and working with HashiCorp Vault.
https://docs.ansible.com/ansible/devel/collections/community/hashi_vault/index.html
GNU General Public License v3.0
80 stars 59 forks source link

doc: add example for write using kv v2 engine #245

Closed askalski85 closed 2 years ago

askalski85 commented 2 years ago
SUMMARY

In order to use the vault_write module I had to experiment for a longer time. Its nice to have such an example directly in the documentation so others could benefit.

ISSUE TYPE
COMPONENT NAME

Updated module: vault_write

ADDITIONAL INFORMATION

none

askalski85 commented 2 years ago

fyi @briantist @felixfontein

github-actions[bot] commented 2 years ago

Docs Build 📝

Thank you for contribution!✨

This PR has been merged and the docs are now incorporated into main: https://community-hashi-vault-main.surge.sh

briantist commented 2 years ago

@askalski85 thank you! I hope to implement dedicated kv modules/plugins that would make this easier, but in the meantime, that is a very helpful example.

I do apologize about the time spent figuring it out. Please feel free to open a discussion for help with things like this in the future.

briantist commented 2 years ago

CI failures are not related to this PR. Despite the status being set back to operational, it seems to be caused by this dockerhub incident: https://status.docker.com/pages/incident/533c6539221ae15e3f000031/626016617fef2d04d335c7d4

codecov[bot] commented 2 years ago

Codecov Report

Merging #245 (2ce7f1e) into main (653f3a9) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #245   +/-   ##
=======================================
  Coverage   97.49%   97.49%           
=======================================
  Files          56       56           
  Lines        2518     2518           
  Branches      185      241   +56     
=======================================
  Hits         2455     2455           
  Misses         49       49           
  Partials       14       14           
Flag Coverage Δ
env_docker-default 97.49% <ø> (ø)
integration 80.55% <ø> (ø)
sanity 38.61% <ø> (ø)
target_ansible-doc 100.00% <ø> (ø)
target_auth_approle 89.47% <ø> (ø)
target_auth_aws_iam 50.00% <ø> (ø)
target_auth_cert 86.36% <ø> (ø)
target_auth_jwt 91.30% <ø> (ø)
target_auth_ldap 89.47% <ø> (ø)
target_auth_none 100.00% <ø> (ø)
target_auth_token 71.42% <ø> (ø)
target_auth_userpass 85.71% <ø> (ø)
target_connection_options 74.76% <ø> (ø)
target_controller 75.51% <ø> (ø)
target_filter_vault_login_token 77.77% <ø> (ø)
target_import 38.61% <ø> (ø)
target_lookup_hashi_vault 81.33% <ø> (ø)
target_lookup_vault_login 100.00% <ø> (ø)
target_lookup_vault_read 90.00% <ø> (ø)
target_lookup_vault_token_create 82.97% <ø> (ø)
target_lookup_vault_write 59.14% <ø> (ø)
target_module_utils 95.90% <ø> (ø)
target_module_vault_login 93.93% <ø> (ø)
target_module_vault_pki_generate_certificate 78.26% <ø> (ø)
target_module_vault_read 92.10% <ø> (ø)
target_module_vault_token_create 90.00% <ø> (ø)
target_module_vault_write 57.53% <ø> (ø)
target_modules 70.19% <ø> (ø)
units 93.50% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
plugins/modules/vault_write.py 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 653f3a9...2ce7f1e. Read the comment docs.