Commit Graph

65 Commits

Author SHA1 Message Date
Loann Le
be4131fc76 vault documentation: doc cleanup effort-batch4 (#16711)
* cleanup effort

* modified text

* Update website/content/docs/internals/integrated-storage.mdx

Co-authored-by: Yoko Hyakuna <yoko@hashicorp.com>

Co-authored-by: Yoko Hyakuna <yoko@hashicorp.com>
2022-08-12 15:39:58 -07:00
Loann Le
38d36c86bc modified wording (#16655) 2022-08-09 15:09:49 -07:00
Loann Le
4c4c041c55 vault documentation: updated architecture doc page (#16569)
* updated content

* fixed spelling error

* Update website/content/docs/internals/architecture.mdx

Co-authored-by: Yoko Hyakuna <yoko@hashicorp.com>

* Update website/content/docs/internals/architecture.mdx

Co-authored-by: Yoko Hyakuna <yoko@hashicorp.com>

* Update website/content/docs/internals/architecture.mdx

Co-authored-by: Yoko Hyakuna <yoko@hashicorp.com>

* Update website/content/docs/internals/architecture.mdx

Co-authored-by: Yoko Hyakuna <yoko@hashicorp.com>

* Update website/content/docs/internals/architecture.mdx

Co-authored-by: Yoko Hyakuna <yoko@hashicorp.com>

* updated content

* italicized barrier

Co-authored-by: Yoko Hyakuna <yoko@hashicorp.com>
2022-08-04 11:29:31 -07:00
Nick Cabatoff
bbc46c12cb Document how replication uses cluster addresses. (#16545) 2022-08-04 09:10:23 -04:00
Loann Le
89750ef7dd Vault documentation: updated install and ha files (#16498)
* revised content

* Update website/content/docs/install.mdx

Co-authored-by: Yoko Hyakuna <yoko@hashicorp.com>

* Update website/content/docs/internals/high-availability.mdx

Co-authored-by: Yoko Hyakuna <yoko@hashicorp.com>

* Update website/content/docs/internals/high-availability.mdx

Co-authored-by: Yoko Hyakuna <yoko@hashicorp.com>

* Update website/content/docs/internals/high-availability.mdx

Co-authored-by: Yoko Hyakuna <yoko@hashicorp.com>

* Update website/content/docs/internals/high-availability.mdx

Co-authored-by: Yoko Hyakuna <yoko@hashicorp.com>

Co-authored-by: Yoko Hyakuna <yoko@hashicorp.com>
2022-08-02 11:40:09 -07:00
Chris Capurso
dee422cc8c add merkle.flushDirty.outstanding_pages metric to docs (#16530) 2022-08-02 12:58:25 -04:00
Peter Wilson
a7111c5c12 Removed IRC reference in architecture internals doc (#15904)
* Removed IRC reference in architecture internals doc
2022-06-09 15:41:14 +01:00
Pratik Khasnabis
d78c99e358 Update to fix the concept of root key, which is not sharded as written here. (#15726)
This explanation of root key is incorrect. Root key is not sharded and reconstructed. The root key is encrypted by the unseal key which is sharded and reconstructed back in the unsealing process.
The explanation differed from the correct one at https://www.vaultproject.io/docs/concepts/seal
2022-06-01 09:54:26 -04:00
Loann Le
74ac7578f9 Vault documentation: updated key share/unseal images (#15526)
* updated images

* added new image files
2022-05-20 10:59:30 -07:00
Loann Le
61dbf65673 Vault documentation: updated unseal information (#15446)
* updated unseal info

* Update architecture.mdx

fixed spelling error

* updated based on feedback

* added new image

* Update website/content/docs/commands/operator/init.mdx

Co-authored-by: Yoko Hyakuna <yoko@hashicorp.com>

* Updates for accuracy

Co-authored-by: Yoko Hyakuna <yoko@hashicorp.com>
2022-05-16 14:44:23 -07:00
Chris Capurso
2ae4459ffc Fix sentence under Integrated Storage (Raft) Autopilot docs (#15231)
Co-authored-by: Peter Zujko <peter.zujko@klaviyo.com>
2022-04-29 11:26:32 -04:00
Nick Cabatoff
0e5a4a6703 Correct the unit type for mount_table.size. (#15114) 2022-04-21 12:54:32 -04:00
Loann Le
cc8e4c4e1a removed duplicate entry (#14758) 2022-03-29 10:38:30 -07:00
John-Michael Faircloth
9680de88ba docs/multiplexing: overhaul plugin documentation (#14509)
* docs/multiplexing: overhaul plugin documentation

* update nav data

* remove dupe nav data

* add external plugin section to index

* move custom plugin backends under internals/plugins

* remove ref to moved page

* revert moving custom plugin backends

* add building plugins from source section to plug dev

* add mux section to plugin arch

* add mux section to custom plugin page

* reorder custom database page

* use 'external plugin' where appropriate

* add link to plugin multiplexing

* fix example serve multiplex func call

* address review comments

* address review comments

* Minor format updates (#14590)

* mv Plugins to top-level; update upgrading plugins

* update links after changing paths

* add section on external plugin scaling characteristics

* add updates on plugin registration in plugin management page

* add plugin learn resource

* be more explicit about mux upgrade steps; add notes on when to avoid db muxing

* add plugin upgrade built-in section

* add caveats to built-in plugin upgrade

* improvements to built-in plugin override

* formatting, add redirects, correct multiplexing use case

* fix go-plugin link

* Apply suggestions from code review

Co-authored-by: Loann Le <84412881+taoism4504@users.noreply.github.com>

* remove single item list; add link to Database interface

Co-authored-by: Yoko Hyakuna <yoko@hashicorp.com>
Co-authored-by: Loann Le <84412881+taoism4504@users.noreply.github.com>
2022-03-22 15:07:32 -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
Jim Kalafut
17747a706f Rename master key -> root key in docs (#14542) 2022-03-16 22:01:38 -07:00
mickael-hc
b57d1e02c9 update security model (#14482)
compromised clients are not part of vault's threat model
2022-03-15 16:27:41 -04:00
Guillaume
785aff956f Added Enigma Vault secret plugin. Designed to be simple but complete, a good starting point for plugin developers (#14389) 2022-03-11 08:33:48 -05:00
Nick Cabatoff
28a6a0e799 Add a place for us to link to external plugin examples/guides. (#14414) 2022-03-10 14:29:29 -05:00
VAL
dae8a00f0c Typo and clarity fixes (#14081) 2022-02-15 10:43:49 -08:00
Victor Rodriguez
1cde29f9f8 Restore tidy-status documentation. (#14075)
Restore tidy-status documentation.

Fixes VAULT-5113.
2022-02-15 11:04:21 -05:00
Victor Rodriguez
5efe75c4f8 Remove documentation for upcoming /pki/tidy-status endpoint. (#14044)
The documentation will be released along with the feature.
2022-02-14 15:41:50 -05:00
Loann Le
f0bff02ca6 changed to upper-case for integrated storage (#14037) 2022-02-14 08:38:06 -08:00
mickael-hc
93a92e141a docs: add cluster-to-cluster communications to external threat overview (#13805) 2022-01-28 10:15:22 -05:00
mickael-hc
13c99dc22f Fix limits docs to reflect listener variable name (#13776) 2022-01-25 16:45:56 -05:00
mickael-hc
7353573d9a docs: update GitHub auth method docs and security model (#13572)
Provide changes based on recent audit feedback: describe risks of third party authentication systems and plugins.
2022-01-05 09:23:55 -08:00
raakatz
417eb9c852 Fix a sentence in architecture.mdx (#13539)
The words "can be" were missing
2022-01-03 16:38:39 -08:00
Tim Peoples
c4bde7365b Update docs to reflect new plugin behavior. (#13543)
* Update docs to reflect that TLS connection state is now available to plugins

* Fix typo (D'oh!)
2022-01-03 11:54:12 -08:00
Meggie
3f1a13a8dd Upgrade guidance updates from VLT-172 (#13327)
* Upgrade guidance updates from VLT-172

Trying to clarify some upgrade questions. Learn update to follow in
separate PR.

* Apply suggestions from code review

Co-authored-by: Nick Cabatoff <ncabatoff@hashicorp.com>

Co-authored-by: Nick Cabatoff <ncabatoff@hashicorp.com>
2021-12-20 13:46:57 -05:00
hghaf099
13b8306575 VAULT-1564 report in-flight requests (#13024)
* VAULT-1564 report in-flight requests

* adding a changelog

* Changing some variable names and fixing comments

* minor style change

* adding unauthenticated support for in-flight-req

* adding documentation for the listener.profiling stanza

* adding an atomic counter for the inflight requests
addressing comments

* addressing comments

* logging completed requests

* fixing a test

* providing log_requests_info as a config option to determine at which level requests should be logged

* removing a member and a method from the StatusHeaderResponseWriter struct

* adding api docks

* revert changes in NewHTTPResponseWriter

* Fix logging invalid log_requests_info value

* Addressing comments

* Fixing a test

* use an tomic value for logRequestsInfo, and moving the CreateClientID function to Core

* fixing go.sum

* minor refactoring

* protecting InFlightRequests from data race

* another try on fixing a data race

* another try to fix a data race

* addressing comments

* fixing couple of tests

* changing log_requests_info to log_requests_level

* minor style change

* fixing a test

* removing the lock in InFlightRequests

* use single-argument form for interface assertion

* adding doc for the new configuration paramter

* adding the new doc to the nav data file

* minor fix
2021-12-08 17:34:42 -05:00
Rémi Lapeyre
73b9f198be Fix some typos (#12289) 2021-11-15 14:52:04 -05:00
Yoko Hyakuna
c6cf9b5829 Fix out-dated hyperlink (#13145) 2021-11-15 09:53:49 -08:00
Loann Le
536ee276eb fixed link error (#13103) 2021-11-10 09:38:02 -08:00
Victor Rodriguez
51d3b79442 VAULT-444: Add PKI tidy-status endpoint. (#12885)
VAULT-444: Add PKI tidy-status endpoint.

Add metrics so that the PKI tidy status can be monitored using telemetry as well.

Co-authored-by: Steven Clark <steven.clark@hashicorp.com>
2021-11-02 11:12:49 -04:00
Nick Cabatoff
fb7dd97e3f Document autopilot metrics (#12612) 2021-10-14 09:03:17 -04:00
Rowan Smith
905ccda15b updated vault.core.license.expiration_time_epoch (#12760) 2021-10-07 07:14:25 -04:00
Calvin Leung Huang
cea721b9ec docs: add plugin limits and lifecycle sections (#12697)
* docs: add plugin limits and lifecycle sections

* remove extranous comments on the limits page

* add more lifecycle cases, review feedback

* address follow-up review feedback

* rename section to "External plugin limits"
2021-10-01 11:59:13 -07:00
Nick Cabatoff
3ec6dc14df Update telemetry docs to include HA forwarding metrics. (#12611) 2021-09-22 12:10:26 -04:00
Chris Capurso
f421fa96c4 Add kv custom key metadata (#12218)
* add custom-metdata flag to "kv metadata put" command

* add kv metadata put command test for custom-metadata flag

* add custom_metadata to kv-v2 api docs

* add custom_metadata to kv-v2 cli docs

* update go.mod

* Add custom metadata limits to docs

* add changelog entry

* update vault-plugin-secrets-kv to @master
2021-08-23 15:49:09 -04:00
Nick Cabatoff
9b578c529a Add docs for metrics from #11472. (#12278) 2021-08-19 09:49:00 -04:00
Loann Le
9ba8b90dc4 Vault Documentation: Added Glossary (#12324)
* added glossary

* Update website/content/docs/glossary.mdx

Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>

* Update website/content/docs/glossary.mdx

Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>

* modified secrets and barrier content based on feedback

Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
2021-08-16 13:08:44 -07:00
Jim Kalafut
70b956ebec Add link to plugin upgrade instructions (#12043) 2021-08-03 15:58:17 -07:00
mickael-hc
28cb68ba11 docs: add barrier key auto-rotation to internals/rotation (#12149)
This functionality was introduced in Vault 1.7.0 and is documented in api-docs/system/rotate-config
2021-08-03 15:52:24 -07:00
SaintMalik
95ff6687b1 Docs: Fix broken link (#12192)
* Docs: Fix broken link

What does this PR do

Fix dead or broken links in this docs page, making navigation easy for others.

* fixing broken link

* fixing broken links
2021-07-28 13:18:54 -07:00
swayne275
276b08d624 Fix minor typo in Internals/Plugins documentation (#12113)
* fix minor plugin doc typo

* fix limits of of typo and related

* forgot to save on this typo fix
2021-07-20 07:21:24 -06:00
Nick Cabatoff
5a9300ffec Fix license expiration metric name in docs. (#12125) 2021-07-19 19:19:32 -04:00
Pratyoy Mukhopadhyay
fbd1fdf89c Update some metric types, fix some wording (#12122) 2021-07-19 14:54:24 -07:00
Meggie
522cfdf20a Elaborating on telemetry persistence (#12119)
* Elaborating on telemetry persistence

Some users understand how an aggregator relates to Vault telemetry, and
some users are approaching this concept for the first time. Those newer
to the concepts benefit from some extra clarification that the metrics
sourced directly from Vault aren't stored anywhere.

Sources:
https://prometheus.io/docs/concepts/metric_types/
https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md
https://docs.splunk.com/observability/metrics-and-metadata/metric-types.html

* Updated summary note
2021-07-19 16:12:29 -04:00
Josh Black
1e68be76e4 Document bolt metrics (#12107) 2021-07-16 11:44:30 -07:00
Danny Hermes
61a62e3e67 Typo fix: period rotation -> periodic rotation (#12011) 2021-07-08 10:45:49 -04:00