Erica Thompson
0660ea6fac
Update README ( #31244 )
...
* Update README
Let contributors know that docs will now be located in UDR
* Add comments to each mdx doc
Comment has been added to all mdx docs that are not partials
* chore: added changelog
changelog check failure
* wip: removed changelog
* Fix content errors
* Doc spacing
* Update website/content/docs/deploy/kubernetes/vso/helm.mdx
Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>
---------
Co-authored-by: jonathanfrappier <92055993+jonathanfrappier@users.noreply.github.com>
Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>
2025-07-22 08:12:22 -07:00
Chris Capurso
69411d7925
VAULT-30108: Include User-Agent header in audit requests by default ( #28596 )
...
* include user-agent header in audit by default
* add user-agent audit tests
* update audit default headers docs
* add changelog entry
* remove temp changes from TestAuditedHeadersConfig_ApplyConfig
* more TestAuditedHeadersConfig_ApplyConfig fixes
* add some test comments
* verify type assertions in TestAudit_Headers
* more type assertion checks
2024-10-07 10:02:17 -04:00
divyaac
8e1db67f6f
Added some documentation ( #28225 )
...
* Added some documentation
* Fix typo
2024-08-30 10:08:03 -07:00
Peter Wilson
8778240665
VAULT-26466: audit - docs for including correlation ID headers by default ( #26778 )
...
* Docs for correlation ID changes
* Updates
* Update website/content/docs/audit/index.mdx
Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
* Update website/content/docs/audit/index.mdx
Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
* Update website/content/docs/audit/index.mdx
Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
* Update website/content/docs/audit/index.mdx
Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
* Create upgrade 1.17 doc and add audit headers info
* Update website/content/docs/audit/index.mdx
Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
* Update website/content/docs/audit/index.mdx
Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
* Update website/content/docs/audit/index.mdx
Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
* Update website/content/docs/upgrading/upgrade-to-1.17.x.mdx
Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
---------
Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
2024-05-09 17:58:01 +00:00
Peter Wilson
e9e79b4c16
Tweak text to clarify ( #26804 )
2024-05-07 11:42:07 +01: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
Peter Wilson
67a167139b
documenting missing option ( #22296 )
...
* documenting missing option
* added comment about setting to zero
2023-08-11 15:00:27 +01:00
Max Bowsher
4ce8e4b00f
Docs: fix inaccurate claim that audit log contains all requests ( #18510 )
...
* Docs: fix inaccurate claim that audit log contains all requests
* I realised there is another category of paths to add
* Unauthenticated requests such as pki/cert/FINGERPRINT are logged
So, remove "authenticated" qualifier.
2023-07-20 16:54:22 -04:00
Peter Wilson
ba52063705
possible typo/error in sentence - cleared up ( #21831 )
2023-07-14 10:05:06 +00: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
Peter Wilson
676d1c69fe
Docs: audit - add warning when disabling device regarding HMAC ( #20715 )
...
* added note to warn of potential issues in disabling audit when using HMAC
* added to command docs pages too
2023-05-23 14:55:55 +01:00
Ashlee M Boyer
06df5b9d95
docs: Migrate link formats ( #18696 )
...
* Adding check-legacy-links-format workflow
* Adding test-link-rewrites workflow
* Updating docs-content-check-legacy-links-format hash
* Migrating links to new format
Co-authored-by: Kendall Strautman <kendallstrautman@gmail.com>
2023-01-25 16:12:15 -08:00
Max Bowsher
aeb1b1e72f
Add option 'elide_list_responses' to audit backends ( #18128 )
...
This PR relates to a feature request logged through HashiCorp commercial
support.
Vault lacks pagination in its APIs. As a result, certain list operations
can return **very** large responses. The user's chosen audit sinks may
experience difficulty consuming audit records that swell to tens of
megabytes of JSON.
In our case, one of the systems consuming audit log data could not cope,
and failed.
The responses of list operations are typically not very interesting, as
they are mostly lists of keys, or, even when they include a "key_info"
field, are not returning confidential information. They become even less
interesting once HMAC-ed by the audit system.
Some example Vault "list" operations that are prone to becoming very
large in an active Vault installation are:
auth/token/accessors/
identity/entity/id/
identity/entity-alias/id/
pki/certs/
In response, I've coded a new option that can be applied to audit
backends, `elide_list_responses`. When enabled, response data is elided
from audit logs, only when the operation type is "list".
For added safety, the elision only applies to the "keys" and "key_info"
fields within the response data - these are conventionally the only
fields present in a list response - see logical.ListResponse, and
logical.ListResponseWithInfo. However, other fields are technically
possible if a plugin author writes unusual code, and these will be
preserved in the audit log even with this option enabled.
The elision replaces the values of the "keys" and "key_info" fields with
an integer count of the number of entries. This allows even the elided
audit logs to still be useful for answering questions like "Was any data
returned?" or "How many records were listed?".
2023-01-11 16:15:52 -05:00
Mike Palmiotto
57017b626e
command/audit: Recommend multiple audit devices ( #18348 )
...
* command/audit: Add note about enabling multiple audit devices
* docs: Recommend multiple audit devices
2022-12-13 17:51:03 -05:00
mickael-hc
e56c075c2b
fix formatting for note in audit section ( #17335 )
2022-09-28 10:17:36 -07:00
mickael-hc
ddf8010342
docs: clarify json types and workaround ( #17318 )
...
* docs: clarify json types and workaround
* Apply suggestions from code review
Co-authored-by: Loann Le <84412881+taoism4504@users.noreply.github.com>
Co-authored-by: Loann Le <84412881+taoism4504@users.noreply.github.com>
2022-09-27 15:35:41 -04:00
Bryce Kalow
fe3daa411a
website: content updates for developer ( #17035 )
...
* Chore (dev portal): update learn nav data links (#15515 )
* Update docs-nav-data.json
* Update docs-nav-data.json
* website: fixes internal redirects (#15750 )
* chore: remove duplicate overview item (#15805 )
* Use `badge` for `<sup>` tags in nav data JSON files (#15928 )
* Replacing <sup> tags with badge
* Adding type and color to badges
* fix broken links in vault docs (#15976 )
* website: Update old learn links to redirect locations (#16047 )
* update previews to render developer UI
* update redirects
* adjust content so it is backwards compat
Co-authored-by: HashiBot <62622282+hashibot-web@users.noreply.github.com>
Co-authored-by: Kendall Strautman <36613477+kendallstrautman@users.noreply.github.com>
Co-authored-by: Ashlee M Boyer <43934258+ashleemboyer@users.noreply.github.com>
2022-09-22 08:11:04 -07:00
Brian Shumate
fea1d13f8d
Audit device: Clarifications based on feedback ( #16881 )
...
- Update blocked audit device to use feedback from #6484
- This PR supersedes #6484
2022-08-26 09:19:49 -04:00
Loann Le
20467b10f2
added link to tutorial ( #15762 )
2022-06-02 10:15:21 -07:00
Loann Le
76a383eea6
updated warning ( #15459 )
2022-05-18 08:26:25 -07:00
Peter Wilson
f2d20eded9
Modified explanation on >=1 audit devices and successful requests ( #15110 )
2022-04-21 09:15:05 -04:00
Rowan Smith
617e62c8bf
Update socket entry ( #14569 )
...
Page edited: https://www.vaultproject.io/docs/audit/socket . We should include a note detailing that Vault may become unresponsive due to a TCP based socket output becoming unavailable per https://www.vaultproject.io/docs/audit#blocked-audit-devices
2022-04-12 19:29:43 -07:00
John-Michael Faircloth
39c952658e
docs: fix plugin redirects and clarify plugin scaling ( #14732 )
...
* docs: fix plugin redirects
* update scaling external plugin text
* fix broken link in audit logs
2022-03-29 15:03:57 -05:00
Yoko Hyakuna
990cd8b929
Fix broken links referencing to API docs ( #14565 )
...
* Fix all '/api/' to '/api-docs/'
* Minor fixes
* Undo some of the unintentional changes
2022-03-17 18:14:48 -07:00
Loann Le
c45db9d058
Documentation update: Added tuner parameters to the Sensitive information section ( #12655 )
...
* added tuner parameter to doc
* reworded the text
* updated text based on feedback
* fine-tuning sentence
* changed to relative links
2021-09-28 11:44:46 -07:00
Mike Green
566767a3c7
Clarify on overview page that audit is default replicated ( #12298 )
...
* Note that audit is replicated
* tweak
* clarify local is to the cluster, not only the node
* tweaking. i think this makes more sense
2021-09-01 13:53:01 -07:00
Bryce Kalow
e27b43c482
feat(website): migrates nav data format and updates docs pages ( #11242 )
...
* migrates nav data format and updates docs pages
* removes sidebar_title from content files
2021-04-06 13:49:04 -04:00
Jeff Escalante
179df992c0
Implement MDX Remote ( #10581 )
...
* implement mdx remote
* fix an unfenced code block
* fix partials path
Co-authored-by: Jim Kalafut <jkalafut@hashicorp.com>
2020-12-17 16:53:33 -05:00
