Commit Graph

591 Commits

Author SHA1 Message Date
Scott Miller
036cbcebd9 First draft of Seal HA documentation (#23252)
* wip

* Initial draft of Seal HA docs

* nav data

* Fix env var name

* title

* Note partially wrapped values and disabled seal participation

* Update website/data/docs-nav-data.json

Co-authored-by: Steven Clark <steven.clark@hashicorp.com>

* correct initial upgrade limitation

* Add note about shamir seals and migration

* fix nav json

* snapshot note

* availability note

* seal-backend-status

* Add a couple more clarifying statements

* header typo

* correct initial upgrade wording

* Update website/content/docs/configuration/seal/seal-ha.mdx

Co-authored-by: Steven Clark <steven.clark@hashicorp.com>

* Update website/content/docs/concepts/seal.mdx

Co-authored-by: Steven Clark <steven.clark@hashicorp.com>

---------

Co-authored-by: Steven Clark <steven.clark@hashicorp.com>
2023-09-22 13:18:48 -05:00
Sarah Chavis
1996c186df [DOCS] Administrative namespace updates (#23208) 2023-09-21 12:07:25 -07:00
divyaac
6ef2a60314 Added patch (#23206) 2023-09-20 18:25:21 -07:00
Nicola Kabar
2a46d492a3 updated the LIST identity/entity-alias/id endpoint docs (#23016)
* updated the LIST identity/entity-alias/id endpoint docs to reflect new data returned

* Update website/content/api-docs/secret/identity/entity-alias.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

* Update website/content/api-docs/secret/identity/entity-alias.mdx

Co-authored-by: Max Bowsher <maxbowsher@gmail.com>

---------

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
Co-authored-by: Max Bowsher <maxbowsher@gmail.com>
2023-09-18 12:30:30 -07:00
Raymond Ho
018e5675fe VAULT 18227/introduce cap ldap library (#22185) 2023-09-14 10:26:29 -07:00
Jason O'Donnell
27d647f97a Update changelog for auth/azure v0.16.2 (#23059)
* update changelog for azure v0.16.2

* Add retry docs
2023-09-13 21:23:01 +00:00
Alexander Scheel
21742020f0 Add API docs on Transit X.509 certificates (#22998)
Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>
2023-09-12 11:35:37 -04:00
Bianca Moreira
1d72ac5278 Fix the administrative banner for sys endpoints (#22888) 2023-09-11 09:20:31 +02:00
vinay-gopalan
2b74a4826b Add documentation for IAM authentication for DB Secrets Engine (#22836)
Co-authored-by: Yoko Hyakuna <yoko@hashicorp.com>
2023-09-08 14:03:50 -07:00
Theron Voran
afd1302cce docs/k8s-auth: non-JWT tokens are now allowed for token_reviewer_jwt (#22857) 2023-09-08 10:40:29 -07:00
John-Michael Faircloth
1870018090 docs: db schedule-based static role rotations (#22863)
* docs: db schedule-based static role rotations

* fix broken link

* add mutual exclusion notice on overview page

* prepend slash to relative link
2023-09-07 16:50:57 -05:00
Josh Black
dbf094940f Add more docs for update-primary (#22677)
* add more docs for update-primary

* Update website/content/api-docs/system/replication/replication-dr.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

* Update website/content/api-docs/system/replication/replication-dr.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

* Update website/content/api-docs/system/replication/replication-dr.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

* Update website/content/api-docs/system/replication/replication-performance.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

* Update website/content/api-docs/system/replication/replication-performance.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

* PR feedback

* Apply suggestions from code review

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

---------

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
2023-09-01 12:42:46 -07:00
Sean Ellefson
2b626eae18 Correcting method from GET to LIST (#22649) 2023-08-30 11:03:23 -07:00
Bianca Moreira
cf43d3eeed Add administrative namespace docs (#22581)
* Add administrative namespace section to namespaces docs
* Tag sys endpoints with restricted admin alert
---------

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
2023-08-30 09:31:53 -07:00
Sarah Chavis
04fc15471b Update alert partials and files that include them (#22556) 2023-08-24 15:30:17 -07:00
divyaac
edbaac3920 Added lease quota count and rate limit count docs (#22509)
* Added lease quota count and rate limit count docs

* Update website/content/api-docs/system/lease-count-quotas.mdx

Co-authored-by: Violet Hynes <violet.hynes@hashicorp.com>

* Edited docs

* Update website/content/api-docs/system/lease-count-quotas.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

* Update website/content/api-docs/system/lease-count-quotas.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

* Update website/content/api-docs/system/rate-limit-quotas.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

---------

Co-authored-by: Violet Hynes <violet.hynes@hashicorp.com>
Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
2023-08-23 16:40:29 -07:00
Josh Black
d50bd4eb05 OSS changes for https://github.com/hashicorp/vault-enterprise/pull/4254 (#22482) 2023-08-21 15:03:44 -07:00
Brian Shumate
614f50de66 Docs: AppRole API docs updates (#19162)
- Add example response for Read AppRole Secret ID
- Add example response for Read AppRole Secret ID Accessor
2023-08-17 16:25:06 -07:00
ssurana90
4ff9fb3fd3 adding explanation for allow_store_key flag , based on internal engineering conversation. (#17258) 2023-08-17 16:00:38 -07:00
Steven Clark
aa81aeaba0 Add api-docs for PKI CIEPS sign-intermediate (#22371)
* Add api-docs for PKI CIEPS sign-intermediate

 - This adds the CIEPS sign-intermediate api-docs and tweaks the existing CIEPS apis to mark the policy url argument as optional.

* Define CIEPS in the first use per section
2023-08-17 08:57:55 -04:00
Michael Dempsey
d6b7e5bfa1 Add support for signed GET requests for aws authentication (#10961)
* Support GET requests for aws-iam

This is required to support presigned requests from aws-sdk-go-v2

* Add GET method tests for aws-iam auth login path

* Update Website Documenation

* Validate GET action even if iam-server header is not set

* Combine URL checks

* Add const amzSignedHeaders to aws credential builtin

* Add test for multiple GET request actions

* Add Changelog Entry

---------

Co-authored-by: Max Coulombe <109547106+maxcoulombe@users.noreply.github.com>
2023-08-15 15:40:12 -04:00
Raja Nadar
47cbcd50c4 Add description for VaultSharp client library (#18298)
* add description for vaultsharp

calling our features and cross platform capabilities along with Enterprise Vault support for enterprise vault users

* Update libraries.mdx for VaultSharp description

---------

Co-authored-by: Violet Hynes <violet.hynes@hashicorp.com>
2023-08-15 15:24:40 -04:00
Chip Stepowski
f0c66d4e26 Add metadata policy requirement for KV-V2 list.mdx (#21812)
* Add metadata policy requirement for KV-V2 list.mdx

Customer requested change as our API docs page does not state the token policy must have access to metadata in the policy when listing KV-V2 secrets. I let them know it exists here: https://developer.hashicorp.com/vault/docs/secrets/kv/kv-v2#acl-rules, in the ACL section, but they wanted to have it added to the API docs as well.

* Update website/content/api-docs/secret/kv/kv-v2.mdx

---------

Co-authored-by: Violet Hynes <violet.hynes@hashicorp.com>
2023-08-15 13:51:44 -04:00
Sarah Chavis
91face4eff convert OSS language to "community" (#22343) 2023-08-15 13:31:52 -04:00
Violet Hynes
c6bd2db5b0 Improve docs around enable_rate_limit_response_headers (#22302) 2023-08-11 13:43:28 -04:00
Marc Chua
22ed7aff3e Add IBM 3rd Tools and Fix PR link (#11901)
Co-authored-by: Violet Hynes <violet.hynes@hashicorp.com>
2023-08-11 09:06:48 -04:00
Pascal Reeb
24a1941b35 chore(api-docs): remove vc since it's unmaintained (#16623)
Co-authored-by: Violet Hynes <violet.hynes@hashicorp.com>
2023-08-09 18:19:26 +00:00
Alexander Scheel
d4e402d597 Docs CIEPS Configuration (#22259)
* Clarify wording, add missing expiration fields

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>

* Add API docs on CIEPS configuration

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>

* Fix ToC, headers to include EnterpriseAlert

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>

* Update website/content/api-docs/secret/pki.mdx

Co-authored-by: Steven Clark <steven.clark@hashicorp.com>

* Update website/content/api-docs/secret/pki.mdx

Co-authored-by: Steven Clark <steven.clark@hashicorp.com>

---------

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>
Co-authored-by: Steven Clark <steven.clark@hashicorp.com>
2023-08-09 09:27:06 -04:00
Alexander Scheel
04a081226d Add docs on CIEPS issuance (#22098)
Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>
2023-08-09 08:01:17 -04:00
John-Michael Faircloth
a1a5be97e2 docs/db: fix outdated static role information (#22239) 2023-08-08 11:02:53 -05:00
Adrian Ding
5c376701ff Add 501 to Vault uninitialized (#22128)
* Add 502 to Vault uninitialized

* Update index.mdx

* Update index.mdx

---------

Co-authored-by: Violet Hynes <violet.hynes@hashicorp.com>
2023-08-08 09:22:49 -04:00
Raymond Ho
0d0cda43d5 clarify docs in ldap/auth for userfilter (#22210) 2023-08-07 13:13:52 -07:00
Adrian Ding
d83e8ed425 add 472 return code (#22105)
* add 472 return code

* Updated the wording for consistency

---------

Co-authored-by: Yoko Hyakuna <yoko@hashicorp.com>
2023-07-28 10:56:20 -07:00
Raymond Ho
4f7a8fb494 AWS auth login with multi region STS support (#21960) 2023-07-28 08:42:22 -07:00
Sarah Chavis
b6d973a133 Make enterprise callouts consistent (#22073) 2023-07-27 17:41:14 +00:00
Florin Cătălin Țiucra-Popa
24a7d966d5 Update cert.mdx (#22076)
* Update cert.mdx

Adding the missing parameter `url` for CRL create endpoint.

* Update website/content/api-docs/auth/cert.mdx

Co-authored-by: Steven Clark <steven.clark@hashicorp.com>

* Update cert.mdx

Corrected the duplicate `crl` line.

---------

Co-authored-by: Steven Clark <steven.clark@hashicorp.com>
2023-07-27 17:09:17 +02:00
Josh Black
d407078766 Don't allow setting dead server last contact threshold to less than 1 minute (#22040)
* Don't allow setting dead server last contact threshold to less than 1 minute

* add changelog

* document the minimum dead server last contact threshold
2023-07-25 20:46:52 +00:00
Conor McCullough
e969e4ae43 Update libraries.mdx (#21846)
* Update libraries.mdx

Hello! We now maintain a dotnet client for Vault, updating the docs to include this info.

* Update libraries.mdx

Removed version flag from Install-Package.

Changed formatting slightly of ansible-vault to match as I think the hyphen + capital first letter looks nicer.

* Remove extra '('

---------

Co-authored-by: Yoko Hyakuna <yoko@hashicorp.com>
2023-07-19 22:26:02 -07:00
Rachel Culpepper
71841c51be Vault-17911: add support for hex values in oid extension (#21830)
* add support for hex values in oid extension

* add changelog

* add length check on split and error handling on unmarshal
2023-07-17 10:58:18 -04:00
Laurent
366693c78d Add a parameter to allow ExtKeyUsage field usage from a role within ACME (#21702)
* imprv: Add a parameter to allow ExtKeyUsage field usage from a role

* chore: Add the changelog entry

* imprv: Reword UI and changelog

* doc: Add allow_role_extkeyusage in parameter list

* imprv: Align variable names with existing fields/codebase

* Add unit test and tweak some labels

---------

Co-authored-by: Steve Clark <steven.clark@hashicorp.com>
2023-07-17 09:31:13 -04:00
Max Winslow
03ba365032 fix sys/raft doc headings (#21591)
* fix sys/raft doc headings

* Update website/content/api-docs/system/storage/raftautosnapshots.mdx

Co-authored-by: Mike Palmiotto <mike@p4lm.io>

---------

Co-authored-by: Mike Palmiotto <mike@p4lm.io>
2023-07-13 15:49:10 +01:00
Jason O'Donnell
237b9f7140 Add documentation for DR reindex endpoint (#21446)
* Add dr reindex doc

* Format
2023-07-07 11:36:38 -04:00
Anton Averchenkov
f4f0412b6a [docs] Convert titles to sentense case (#21426)
* Convert documentation titles to sentense case

* Docker, Google, Foundry, Cloud proper case
2023-06-30 19:22:07 -04:00
Max Bowsher
43ae739971 Refactor identity/mfa/method/* endpoints to fix bad OpenAPI (#20879)
* Refactor `identity/mfa/method/*` endpoints to fix bad OpenAPI

There is a problem with how the `identity/mfa/method/*` endpoints are
defined, resulting in incorrect OpenAPI generation.

I raised hashicorp/vault-client-go#180 to track a consequence, and
opened #20873 which explains the problem and adds a log message to
detect it.

This PR is now the fix.

It's actually quite an interesting problem, that has come about through
some particular implementation choices, in Vault's first/only case where
REST API objects are created by writing to the collection URL, and have
their ID allocated by the server, instead of the client.

The triggering cause of the malfunction was trying to have a single
framework.Path struct instance which optionally includes or excludes the
method_id path parameter, and also another framework.Path struct
instance handling list operations.

The fix is to simplify the path regexes, and have one framework.Path
which handles the method_id being present, and one that handles it being
absent.

The diff is somewhat large, because the affected code had been
copy/pasted four times (TOTP, Okta, Duo, PingID) - so I took the
opportunity to fix the duplication, creating appropriate helper methods
so that the quadruplicated code could be re-unified.

* Revise documentation

This update refactors how the documentation presents these endpoints to
users, both for clarity, and to align with the new structure of the
code.

From a user perspective, it clears up some unclear presentation of when
the `method_id` parameter should and should not be present, adds
a missing description of the response to create requests, and changes
the `method_id` parameter name to be used consistently (rather than `id`
in some cases, unlike the actual code/OpenAPI).

* Fix incorrect acronym (review fix)

* Accept suggestion of tweaked grammar in documentation

Co-authored-by: Anton Averchenkov <84287187+averche@users.noreply.github.com>

* Add changelog

---------

Co-authored-by: Anton Averchenkov <84287187+averche@users.noreply.github.com>
2023-06-23 13:32:41 -04:00
Shubham P
e3dad5b6da add loopback4-vault in node.js client libraries (#21008) 2023-06-22 13:23:01 -07:00
Rowan Smith
c7db2d61b0 [Docs] ldap auth add VAULT_LDAP_PASSWORD environment variable (#21407)
Add VAULT_LDAP_PASSWORD environment variable
2023-06-22 11:31:26 -07:00
Violet Hynes
8e40823fe1 Some small KV API docs improvements (#21395) 2023-06-22 13:39:47 -04:00
Steven Clark
eb634e9326 Remove bump_version from transit import docs (#21393)
- The argument was removed along the development path, but the
   documentation was not updated.
2023-06-21 15:36:52 -04:00
Anton Averchenkov
e31ead37ba [docs] Add Agent & Proxy to related tools (#21352) 2023-06-19 14:15:03 -04:00
Violet Hynes
d76424cb53 Miscellaneous docs cleanups (#21327) 2023-06-16 15:38:58 -04:00