Commit graph

559 commits

Author SHA1 Message Date
Jim Kalafut 22e948839a
Fix Azure Secrets docs typo 2019-12-19 10:24:37 -08:00
Michel Vocks 9cff3fab58
Docs: Add missing KV V2 version argument to API docs (#8018) 2019-12-16 09:35:48 +01:00
Becca Petrin b0d1455ea3
add sts_region to aws auth api docs (#8001) 2019-12-11 13:45:39 -08:00
ncabatoff 828a345dbc
Update KMIP docs re supported operations. (#8008) 2019-12-11 16:22:25 -05:00
Becca Petrin 38262005dc
Kerberos docs (#7993) 2019-12-11 11:16:36 -08:00
ncabatoff fde5e55ce9
Handle otherName SANs in CSRs (#6163)
If a CSR contains a SAN of type otherName, encoded in UTF-8, and the signing role specifies use_csr_sans, the otherName SAN will be included in the signed cert's SAN extension.

Allow single star in allowed_other_sans to match any OtherName.  Update documentation to clarify globbing behaviour.
2019-12-11 10:16:44 -05:00
Clint 54a8b20875 Remove response code info from non-overview API docs (contd) (#7940)
Continues https://github.com/hashicorp/vault/pull/6459 and cleans up
some spots that should have been deleted, but due to markdown
formatting, weren't rendering anyway.

> Remove response code info from non-overview API docs as it can be
> misinterpreted and is always the same anyways.
2019-12-02 10:07:46 -08:00
catsby 66bb372fca
fix website formatting 2019-11-26 17:02:10 -06:00
Yong Wen Chua e17f82dec1 Add new fields to K8S Auth Documentation (#7509)
- Added in https://github.com/hashicorp/vault-plugin-auth-kubernetes/pull/70
2019-11-26 16:48:30 -06:00
Calvin Leung Huang 6550b9969c
docs: add request_timeout to config docs for secrets/ad and auth/ldap backends (#7917) 2019-11-20 13:30:33 -08:00
Marcus T d61b425aec Misc Documentation Fixes (#7662)
* Update parameter names to match URL placeholders

* Fix incorrect parameter quoting

Without the separated quoting, the entire `ec2_alias (string: "role_id")` string becomes an anchor link.

* Fix default value for userattr

vault/sdk/helper/ldaputil/config.go shows userattr has a default value of "cn"

* Fix default value for url

Documentation says it's required, but vault/sdk/helper/ldaputil/config.go shows that url has a default value.

* Fix default value for url

Documentation says it's required, but vault/sdk/helper/ldaputil/config.go shows that url has a default value.
2019-11-19 16:17:45 -06:00
Brian Shumate e3e35e7bc4 Typo (#7880) 2019-11-14 08:53:42 -08:00
Brian Kassouf afe28f252a
Reindex docs (#7868)
* update reindex docs

* update reindex docs
2019-11-12 11:54:04 -08:00
Michel Vocks f5719b9fee Docs: Add filtered paths api docs (#7786) 2019-11-11 15:25:48 -08:00
Calvin Leung Huang 9163874c9b
docs: add sys/config/state docs (#7654) 2019-11-11 14:36:09 -08:00
Calvin Leung Huang 859deacd46
docs: add API docs for sys/leases/tidy (#7781) 2019-11-11 12:35:59 -08:00
Yoko 91daee9dbf
Adding more description (#7841) 2019-11-11 10:01:31 -08:00
Jeff Mitchell f2f984557e
Add ability to renew by accessor (#7817)
* Add renewing by accessor

* Add accessor renewing test and fix bug

* Update website docs

* Remove extra newline

* Add command-level test
2019-11-08 11:32:01 -05:00
Brian Shumate 8363d9fc1d Clarify language around 472 (#7814)
- use "disaster recovery mode"
- remove trailing spaces
2019-11-06 14:16:39 -08:00
Jeff Mitchell 7c4c53e523
Document secondary activation public key endpoints/params (#7810) 2019-11-06 16:37:46 -05:00
Kevin Pruett ef903d4f81 website: Homepage updates, use case pages, navigation changes (#7782)
* website: various updates

* Expose /docs and /intro views using documentation-style
layout for index pages

* Add [Use Case] Secrets Management page

* Add [Use Case] Data Encryption page

* Add [Use Case] Identity Based Access page

* Update redirects file removing `/intro` routes redirecting to
`learn.hashicorp`

* Hide MegaNav on mobile

* website: route /api straight to documentation

* Bybass index page and jump straight to content
2019-11-05 19:54:24 -05:00
Pascal Enz 33c1b7150f Rabbitmq topic permissions (#7751)
* Upgraded rabbit hole library to 2.0

* Added RabbitMQ topic permission support.

* Updated docs to cover RabbitMQ topic permissions.

* Improved comments and docs as suggested.
2019-10-30 14:19:49 -07:00
ncabatoff 5b8a4ba5b8
Add recovery mode docs. (#7667) 2019-10-29 16:42:47 -04:00
Lexman 28aff44616 adds documentation for entropy augmentation (#7721)
* adds documentation for entorpy augmentation

* adds a link to pkcs11 seal configuration from a mention of it
2019-10-28 15:04:27 -07:00
spiff efb2751e00 Change "Generate Intermediate" example to exported (#7515)
The example request for "Generate Intermediate" was type "internal", but the example response contained the private key, which "internal" doesn't do. This patch fixes the example request to be type "exported" to match the example response.
2019-10-25 12:21:55 -04:00
Jeff Mitchell 1a77ce36be
Update transit docs to add aes128/p384/p521 information (#7718) 2019-10-23 10:26:11 -04:00
DevOps Rob 37a23cfb23 Fixing a typo with the sample payload (#7688)
This typo is related to  https://github.com/hashicorp/vault/issues/7603 .  The typo was causing issues with getting this working correctly when following the guide.  I imagine any other newbie to this plugin will have the same struggle.  I had to delve into the source code to figure it out
2019-10-17 21:47:45 -07:00
Michael Gaffney b48ce3d95f
Docs: add examples for when a seal rewrap is useful (#7689) 2019-10-17 14:01:17 -04:00
Mike Jarmy 9e7beeb56d
Document the Agent request_require_header option (#7678)
* document the require_request_header option in Agent

* document the require_request_header option in Agent

* document the require_request_header option in Agent

* document the require_request_header option in Agent

* minor tweaks to docs
2019-10-17 10:08:59 -04:00
Becca Petrin c1b5ca7d57
Add docs for Active Directory secret check-out (#7664) 2019-10-16 15:41:11 -07:00
Michael Gaffney c9804941a5
Add document for sealwrap/rewrap endpoint (#7676)
* Add documentation for seal wrap re-wrap endpoint

* Update sample response for seal rewrap status

* Updates based on feedback from reviewers
2019-10-16 15:46:43 -04:00
Jim Kalafut 7e8b9addd0
Update Azure Secrets docs to include group assignment (#7656) 2019-10-15 08:58:22 -07:00
Brian Shumate d53f3b7d27 Docs: update Oracle Database Secrets Engine API (#7520)
- Add missing `username` and `password` connection parameters
- Use templated root credential in example connection payload
2019-10-15 11:13:09 -04:00
Jack Kleeman ffb699e48c Add ability to skip 'LIST ALL' check (#7614)
Currently whenever we start a new C* session in the database plugin, we
run `LIST ALL` to determine whether we are a superuser, or otherwise
have permissions on roles. This is a fairly sensible way of checking
this, except it can be really slow when you have a lot of roles (C*
isn't so good at listing things). It's also really intensive to C* and
leads to a lot of data transfer. We've seen timeout issues when doing
this query, and can of course raise the timeout, but we'd probably
prefer to be able to switch it off.
2019-10-14 16:36:49 -06:00
Jim Kalafut b3d53e4ef2
Fix Azure auth api docs (#7649)
Fixes #7648
2019-10-14 10:12:45 -07:00
Vlad Fedosov dc3a8c175a New third-party tool added (#7596) 2019-10-09 15:56:34 -04:00
Calvin Leung Huang 9622a351ae docs: add sys/pprof API docs (#7562)
* docs: add sys/pprof api docs

* fix header
2019-10-07 11:55:17 -04:00
Calvin Leung Huang dd02d94a41 docs: add sys/host-info API docs (#7563)
* docs: add sys/host-info api docs

* remove extra closing bracket in sample response
2019-10-07 11:54:48 -04:00
Brian Shumate 77311bf24f Docs: update Transit Secrets Engine Create Key (#7568)
- Use type that supports derivation in sample payload
2019-10-04 10:56:18 -07:00
ncabatoff e7fe4b6d92
Return a useful error on attempts to renew a token via sys/leases/renew (#7298) 2019-10-02 10:55:20 -04:00
Jim Kalafut 9c80c3770a
Fix identity token API docs (#7545) 2019-10-01 16:13:21 -07:00
Jim Kalafut 153c4cc80e
Add 1.2+ role parameters back to JWT API docs (#7544)
This reverts 24c2f8c2ad76, which pulled the parameters while there were
outstanding bugs when using them with JWT auth.
2019-10-01 16:07:52 -07:00
Brian Shumate 54a45db46d Update sample request (#7431)
- Format curl command to be similar to other sample requests
- Add single quotes to URL for '?' so that example is functional
- Delete trailing space
2019-09-25 13:32:42 -07:00
minitux 88da7ecd82 Fix api auth approle documentation (#7382)
Change policies to token_policies
2019-09-25 13:27:27 -07:00
Joel Thompson 551b7a5e5c secret/aws: Support permissions boundaries on iam_user creds (#6786)
* secrets/aws: Support permissions boundaries on iam_user creds

This allows configuring Vault to attach a permissions boundary policy to
IAM users that it creates, configured on a per-Vault-role basis.

* Fix indentation of policy in docs

Use spaces instead of tabs
2019-09-19 16:35:12 -07:00
Yahya 936af3650c [Docs] Fix typo in database sample request (#7492) 2019-09-19 10:14:34 +02:00
Michael Gaffney fdc1274c70
Fix the transit trim key api doc (#7453) 2019-09-18 09:29:58 -04:00
Justin Weissig ec41f0d775 docs: fixed sample json payload parse error (#7484)
Fixed malformed json example (removed extra comma). Here's the payload parse error I was running into with the example.

```
{
  "rotation_period":"12h",
  "verification_ttl":43200,
}
```

Vault does not like this JSON.

```
curl -s \
    --header "X-Vault-Token: ..." \
    --request POST \
    --data @payload-2.json \
    http://127.0.0.1:8200/v1/identity/oidc/key/named-key-001 | jq
{
  "errors": [
    "failed to parse JSON input: invalid character '}' looking for beginning of object key string"
  ]
}
```
2019-09-17 11:42:01 +02:00
Becca Petrin d416b5a838
document role aws auth role name casing (#7356) 2019-09-16 11:55:03 -07:00
David Rubin a2a22e6611 Remove vaulted as supported nodejs client (#7404)
Vaulted is no longer maintained according to the readme. 

https://github.com/chiefy/vaulted#vaulted 

"No Longer Being Maintained Use node-vault for future support of Vault features!"
2019-09-13 16:33:15 -07:00