Skip to content

Commit

Permalink
Doc updates (#524)
Browse files Browse the repository at this point in the history
* fix list method call

* update docs
  • Loading branch information
drewmullen committed Sep 16, 2019
1 parent 43ce194 commit 7485853
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 24 deletions.
26 changes: 3 additions & 23 deletions docs/overview.rst
Expand Up @@ -142,33 +142,13 @@ Preferred usage:
.. doctest:: kvv1
:skipif: client.sys.retrieve_mount_option('secret', 'version', '1') != '1'

>>> client.secrets.kv.default_kv_version = '1'
>>> create_response = client.secrets.kv.create_or_update_secret('foo', secret=dict(baz='bar'))
>>> read_response = client.secrets.kv.read_secret('foo')
>>> create_response = client.secrets.kv.v1.create_or_update_secret('foo', secret=dict(baz='bar'))
>>> read_response = client.secrets.kv.v1.read_secret('foo')
>>> print('Value under path "secret/foo" / key "baz": {val}'.format(
... val=read_response['data']['baz'],
... ))
Value under path "secret/foo" / key "baz": bar
>>> delete_response = client.secrets.kv.delete_secret('foo')



Generic usage:

.. note::

The following `read()` and `write()` methods are roughly equivalent to the equivalent Vault CLI commands. These methods do not offer the same level of validation that hvac methods specific to individual auth methods and secrets engines provide.

.. doctest:: kvv1
:skipif: client.sys.retrieve_mount_option('secret', 'version', '1') != '1'

>>> client.write('secret/foo', baz='bar', lease='1h')
>>> read_response = client.read('secret/foo')
>>> print('Value under path "secret/foo" / key "baz": {val}'.format(
... val=read_response['data']['baz'],
... ))
Value under path "secret/foo" / key "baz": bar
>>> client.delete('secret/foo')
>>> delete_response = client.secrets.kv.v1.delete_secret('foo')


Authentication
Expand Down
2 changes: 1 addition & 1 deletion docs/usage/auth_methods/ldap.rst
Expand Up @@ -17,7 +17,7 @@ Enabling the LDAP Auth Method
ldap_auth_path = 'company-ldap'
description = "Auth method for use by team members in our company's LDAP organization"
if '%s/' % ldap_auth_path not in vault_client.list_auth_backends():
if '%s/' % ldap_auth_path not in vault_client.sys.list_auth_methods():
print('Enabling the ldap auth backend at mount_point: {path}'.format(
path=ldap_auth_path,
))
Expand Down

0 comments on commit 7485853

Please sign in to comment.