238 Commits

Author SHA1 Message Date
miagilepner
d5e7ac934a
VAULT-24580: Add ACME to client count docs (#27040)
* add acme client documentation

* add to all metrics

* add acme to current month response
2024-05-24 11:30:32 +02:00
Peter Wilson
b64b9b15f0
Consistency using HMAC'd vs HMAC'ed (#26875) 2024-05-08 11:13:23 +00:00
Mark Lewis
e6a4b8290e
Update metrics.mdx (#24539)
Adding a note to clarify to customers that the standby nodes will not respond to metrics requests to this API endpoint
---------

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
2024-05-01 14:17:54 -07:00
Jason Peng
5f4e53e5a2
Update health.mdx (#26264)
To address the confusion on 472 status code, in addition to explain in rare occasions when a 429 could be returned.
2024-04-22 15:45:20 -07:00
akshya96
d44ec076b8
retention months docs changes (#26563) 2024-04-19 14:57:10 -07:00
Nick Cabatoff
d1e1d47b05
Update api docs to reflect changes brought in by replication canary and clock skew (#25762) 2024-04-16 09:12:31 -04:00
Meggie
d52db741f5
Add to admin namespace (#26293)
* Add to admin namespace

Add sys/config/group-policy-application to admin namespace endpoints.

* Endpoint can now be accessed from admin ns
2024-04-15 16:49:47 -04:00
Chris Capurso
5870b423a3
remove extraneous max_leases and role fields (#26376) 2024-04-11 13:18:22 -04:00
Chelsea Shaw
6091ad4f71
Remove internal version endpoint (#25998)
* VAULT-24469 use sys/seal-status instead of internal version endpoint

* Update tests and mirage handlers

* Revert "VAULT-20669: Add New Authenticated Endpoint for Version  (#23740)"

This reverts commit 550c99ae3b6553f12e4a862c915155b8d0a53516.

* Readded version_test.go

* Reverted any old changes on versionlgo

---------

Co-authored-by: divyaac <divyaac@berkeley.edu>
2024-03-21 09:14:22 -07:00
John-Michael Faircloth
594d304f25
api: do not require sudo for GetAuth wrapper (#25968)
* api: do not require sudo for GetAuth wrapper

* changelog
2024-03-15 14:40:22 -07:00
Sean Ellefson
b44d9fc19f
Correcting Sample Request to use token and POST (#23910) 2024-03-13 18:30:40 +00:00
Chris Capurso
8db1aa1d41
change "lease count" to "rate limit" (#25899) 2024-03-12 16:21:29 -04:00
Chris Capurso
db55fa42d4
Add clarification to quota docs regarding parent ns access (#25894)
* clarify quota operation restrictions against parent/sibling ns

* update lease count quota docs

* Reword LIST endpoint description
2024-03-12 16:04:07 -04:00
miagilepner
e31413d6cf
VAULT-23089: Doc updates for secret sync billing (#24955)
* add secret sync clients

* update docs and add metrics

* add to operator usage

* entities -> secrets
2024-03-12 10:06:51 +00:00
Tom Proctor
86be20e5d9
Docs: New plugins pinned versions APIs (#25604) 2024-03-08 12:48:16 +00:00
Scott Miller
ba193334ce
Remove the available in language, since our docs are versioned now (#25747) 2024-03-04 13:03:45 -06:00
Steven Clark
ab75d03a6c
Add new /sys/well-known interface to get information about registered labels (#25695)
* Add new /sys/well-known interface to get information about registered labels

 - Add two new interfaces LIST/GET /sys/well-known which will provide
   a list of keys which are registered labels within the /.well-known space on
   the local server, along with a detailed info map for each
 - Add GET /sys/well-known/<label> to get details on a specific registered label
 - Add docs and tests for the new api endpoints

* Add test doc and remove copied comment

* Rename returned fields to use snake case

* Remove extra newline added when resolving the merge conflict

* 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>
2024-02-29 17:07:49 -05:00
Marc Boudreau
9ec4d839f3
VAULT-24439: Make sys/config/ui/custom-messages enterprise paths (#25696)
* remove uiCustomMessagePaths from System backend paths

* adjust documentation

* grammar improvements in docs

* add ENT badge to custom-message api docs page in ToC
2024-02-29 11:45:22 -05:00
Max Coulombe
f94e2156ce
* adjust sync config disclaimer (#25630) 2024-02-27 09:57:46 -05:00
Raymond Ho
2b46f5e523
docs: sync/github-apps (#25569) 2024-02-22 22:53:15 +00:00
vinay-gopalan
2dc73f0636
Add documentation for AWS Plugin WIF (#25398) 2024-02-21 09:19:43 -08:00
Austin Gebauer
66cdf14fe5
sync/gcp: documents project_id parameter for syncing with target projects (#25504) 2024-02-20 15:27:31 -08:00
Max Coulombe
b33e37df84
Docs/vault 23837/sync doc update (#25433)
* + documented the new sync API options
2024-02-17 14:58:50 -05:00
Peter Wilson
94fb339b31
VAULT-22483: Audit filter docs (#24903)
* Tidy up of files

* Add concepts page for filtering

* Update 'Common configuration options'

* Update table format (metrics)

* Filtering metrics

* audit specific filtering

* Fix nav and naming of files

* updates to audit filtering concept page

* Tweaks

* audit updates and glossary page addition for 'request'

* update CLI docs (audit enable)

* added metrics to 'all metrics' page

* fallback example and link fix

* improve links

* updated based on feedback

* some extra details on a request for glossary

* format fix

* use description on fallback device

* test message properties

* Sort out weird merge for events.mdx

* Update website/content/docs/concepts/filtering/audit.mdx

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

* Update website/content/docs/concepts/filtering/audit.mdx

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

* Update website/content/docs/concepts/filtering/audit.mdx

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

* Update website/content/docs/concepts/filtering/audit.mdx

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

* Update website/content/docs/concepts/filtering/audit.mdx

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

* Intro paragraph about filtering/normal devices, and uppercase bullets

* Fix casing on bullets and table layour

* Uppercase bullets

* Update website/content/docs/glossary.mdx

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

* Improvement?

* PR feedback

* Updated based on PR feedback

* Include common options

* Update website/content/docs/concepts/filtering/index.mdx

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

* Update website/content/docs/concepts/filtering/index.mdx

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

* Update website/content/docs/concepts/filtering/index.mdx

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

* Update website/content/docs/concepts/filtering/index.mdx

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

* Update website/content/docs/concepts/filtering/index.mdx

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

* Update website/content/docs/concepts/filtering/index.mdx

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

* Update website/content/docs/concepts/filtering/index.mdx

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

* Update website/content/docs/concepts/filtering/index.mdx

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

* Update website/content/docs/concepts/filtering/index.mdx

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

* Update website/content/docs/concepts/filtering/index.mdx

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

* Remove extra space

* Update website/content/docs/concepts/filtering/index.mdx

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

* Split out metrics

* Update website/content/docs/concepts/filtering/index.mdx

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

* Update website/content/docs/concepts/filtering/index.mdx

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

* Update website/content/docs/concepts/filtering/index.mdx

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

* Update website/content/docs/concepts/filtering/index.mdx

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

* Update website/content/docs/concepts/filtering/index.mdx

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

* Update website/content/docs/concepts/filtering/index.mdx

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

* Update website/content/docs/concepts/filtering/index.mdx

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

* Remove extra word

* Updated table formatting, remove close code block etc.

* Update website/content/docs/concepts/filtering/index.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>
2024-02-16 18:34:25 +00:00
Marc Boudreau
dcde458e33
VAULT-23051: Documenting API Endpoints (#24845)
* api documentation changes

* document management endpoints

* add new website page to the navigation

* include explanation message retrieval from namespaces up to root namespace

* added clarification statement to the create and update operations documentation

* fixed inconsistency in sample request

* Apply suggestions from code review

Co-authored-by: Jonathan Frappier <92055993+jonathanfrappier@users.noreply.github.com>

---------

Co-authored-by: Jonathan Frappier <92055993+jonathanfrappier@users.noreply.github.com>
2024-01-19 16:13:03 -05:00
Tom Proctor
80f85a05f6
New root namespace plugin reload API sys/plugins/reload/:type/:name (#24878) 2024-01-17 15:46:27 +00:00
helenfufu
c6ba0f44ba
update /sys/leader api docs (#24816) 2024-01-11 13:27:53 -06:00
claire bontempo
db7e4b4283
small doc fix (#24720) 2024-01-09 13:47:34 -08:00
divyaac
87ab7497fa
Docs changes (#24242) 2024-01-05 15:31:16 -08:00
Andy Assareh
ab2e0e5a28
typo corrections - spelling and grammar (#24625)
* typo corrections - spelling

* spelling and grammar
2024-01-04 12:50:42 -05:00
Max Coulombe
1cae21fb2f
Fix small doc error (#24627)
* fix small doc error for vercel destination

Co-authored-by: Calvin Leung Huang <1883212+calvn@users.noreply.github.com>

---------

Co-authored-by: Calvin Leung Huang <1883212+calvn@users.noreply.github.com>
2023-12-22 09:14:22 -05:00
benz0
954da5006c
Update audit.mdx (#24561)
* Update audit.mdx

Per the discussion here: https://hashicorp.enterprise.slack.com/archives/CPEPB6WRL/p1656678311708759

This parameter does not apply to DR replication.
This document should specify that the `local` parameter only applies to performance replication because even with this enabled the audit device configuration is still replicated to a DR cluster. This is also the expected and desired behavior.

* Fixed typos

---------

Co-authored-by: Yoko Hyakuna <yoko@hashicorp.com>
2023-12-19 18:10:53 +00:00
claire bontempo
2c19bbe145
Consistently refer to Key Value secrets engine as KV (#24529)
* VAULT-21427 change ui references from K/V to KV

* references in docs/

* website json data

* go command errors

* replace Key/Value with Key Value

* add changelog

* update test

* update secret list header badge

* two more test updates
2023-12-14 11:28:58 -08:00
Tom Proctor
030bba4e68
Support rootless plugin containers (#24236)
* Pulls in github.com/go-secure-stdlib/plugincontainer@v0.3.0 which exposes a new `Config.Rootless` option to opt in to extra container configuration options that allow establishing communication with a non-root plugin within a rootless container runtime.
* Adds a new "rootless" option for plugin runtimes, so Vault needs to be explicitly told whether the container runtime on the machine is rootless or not. It defaults to false as rootless installs are not the default.
* Updates `run_config.go` to use the new option when the plugin runtime is rootless.
* Adds new `-rootless` flag to `vault plugin runtime register`, and `rootless` API option to the register API.
* Adds rootless Docker installation to CI to support tests for the new functionality.
* Minor test refactor to minimise the number of test Vault cores that need to be made for the external plugin container tests.
* Documentation for the new rootless configuration and the new (reduced) set of restrictions for plugin containers.
* As well as adding rootless support, we've decided to drop explicit support for podman for now, but there's no barrier other than support burden to adding it back again in future so it will depend on demand.
2023-11-28 14:07:07 +00:00
Robert
3726d8fb1d
Add configuration section to sync API docs (#24179)
* Add configuration section

* Add restricted root namespace alert
2023-11-27 16:10:37 -06:00
Steven Clark
b7dff9777d
Allow backends to extract credentials from payloads and trigger an authentication workflow (#23924)
* wip

* Work on the tuneable allowance and some bugs

* Call handleCancellableRequest instead, which gets the audit order more correct and includes the preauth response

* Get rid of no longer needed operation

* Phew, this wasn't necessary

* Add auth error handling by the backend, and fix a bug with handleInvalidCredentials

* Cleanup req/resp naming

* Use the new form, and data

* Discovered that tokens werent really being checked because isLoginRequest returns true for the re-request into the backend, when it shouldnt

* Add a few more checks in the delegated request handler for bad inputs

 - Protect the delegated handler from bad inputs from the backend such
   as an empty accessor, a path that isn't registered as a login request
 - Add similar protections for bad auth results as we do in the normal
   login request paths. Technically not 100% needed but if somehow the
   handleCancelableRequest doesn't use the handleLoginRequest code path
   we could get into trouble in the future
 - Add delegated-auth-accessors flag to the secrets tune command and
   api-docs

* Unit tests and some small fixes

* Remove transit preauth test, rely on unit tests

* Cleanup and add a little more commentary in tests

* Fix typos, add another failure use-case which we reference a disabled auth mount

* PR Feedback

 - Use router to lookup mount instead of defining a new lookup method
 - Enforce auth table types and namespace when mount is found
 - Define a type alias for the handleInvalidCreds
 - Fix typos/grammar
 - Clean up globals in test

* Additional PR feedback

 - Add test for delegated auth handler
 - Force batch token usage
 - Add a test to validate failures if a non-batch token is used
 - Check for Data member being nil in test cases

* Update failure error message around requiring batch tokens

* Trap MFA requests

* Reword some error messages

* Add test and fixes for delegated response wrapping

* Move MFA test to dedicated mount

 - If the delegated auth tests were running in parallel, the MFA test
   case might influence the other tests, so move the MFA to a dedicated
   mount

* PR feedback: use textproto.CanonicalMIMEHeaderKey

 - Change the X-Vault-Wrap-Ttl constant to X-Vault-Wrap-TTL
   and use textproto.CanonicalMIMEHeaderKey to format it
   within the delete call.
 - This protects the code around changes of the constant typing

* PR feedback

 - Append Error to RequestDelegatedAuth
 - Force error interface impl through explicit nil var assignment on
   RequestDelegatedAuthError
 - Clean up test factory and leverage NewTestSoloCluster
 - Leverage newer maps.Clone as this is 1.16 only

---------

Co-authored-by: Scott G. Miller <smiller@hashicorp.com>
2023-11-21 14:36:49 -05:00
Max Coulombe
af46b954f6
Document secrets sync LIST request modifications (#23975)
* * document list request adjustments

---------

Co-authored-by: Robert <17119716+robmonte@users.noreply.github.com>
2023-11-10 09:04:26 -05:00
Steven Clark
750ab337ea
Add missing allowed_managed_key param to mount creation doc (#23948)
- We had updated the mount tune api, but missed it within the
   creation api docs
2023-11-02 08:26:00 -04:00
Raymond Ho
2c8dea8733
remove subscription id in docs (#23923) 2023-10-31 15:17:57 -07:00
Marc Boudreau
550c99ae3b
VAULT-20669: Add New Authenticated Endpoint for Version (#23740)
* add sys/internal/ui/version path

* add read capability for sys/internal/ui/version in default policy

* add changelog file

* doc: add api-docs page for sys/internal/ui/version

* add godoc for pathInternalUIVersion function

* add tests for functions in version package

* remove unreachable code

* use closure to restore version at end of test function

* use an example version in sample response

* Update website/content/api-docs/system/internal-ui-version.mdx

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

* Apply suggestions from code review

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

* Update website/content/api-docs/system/internal-ui-version.mdx

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

* add copyright header to version_test.go

---------

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
2023-10-26 12:52:52 -04:00
claire bontempo
db4819427a
docs/add line separators to curl requests secrets sync (#23681)
* add line separators to curl requests

* revert unsync change
2023-10-23 08:29:26 -07:00
Brian Scholer
a0a150b7f1
Update step-down.mdx to describe behavior against non-active nodes (#23657)
* Update step-down.mdx to describe behavior against non-active nodes

Behavior changed in Vault 1.9:
https://developer.hashicorp.com/vault/docs/v1.9.x/commands/operator/step-down
2023-10-18 19:33:46 -07:00
claire bontempo
676ed96a6c
minor doc fixes (#23656) 2023-10-13 21:55:19 -04:00
claire bontempo
9197f002eb
fix repository typo (#23654) 2023-10-13 13:39:31 -07:00
Skybladev2
a485837cb6
Add method and path for Read the client count configuration (#23551) 2023-10-12 10:10:04 -04:00
Sarah Chavis
1b7b5a1c6e
Update enterprise vs hcp alerts (#23619) 2023-10-11 17:59:27 -05:00
Skybladev2
ec026ad2ce
Remove asterixes in header (#23548) 2023-10-09 13:03:54 -07:00
Max Coulombe
acf0736590
Slight rephrase for the association API endpoints (#23393)
* slight rephrase for the association API endpoints
---------

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
2023-10-05 14:53:21 -04:00
Sarah Chavis
8ee4b1e1d0
[DOCS] Confirm restricted endpoint alerts (main) (#23514)
* Make sure includes are fully correct
* Remove duplicates and sort A-Z
2023-10-05 13:00:40 -04:00
Hamid Ghaf
305d6d9b67
merkle corruption checker docs (#22971)
* merkle corruption checker docs

* doc link fix

* fix the link again

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

Co-authored-by: Mike Palmiotto <mike.palmiotto@hashicorp.com>

* Apply suggestions from code review

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
Co-authored-by: Mike Palmiotto <mike.palmiotto@hashicorp.com>

* feedback

* Apply suggestions from code review

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

---------

Co-authored-by: Mike Palmiotto <mike.palmiotto@hashicorp.com>
Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
2023-09-28 15:11:16 -07:00