Commit Graph

119 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
Daniel Greeninger
c87f1b90b5
Update limits.mdx (#26704)
corrected typo
2024-05-10 17:35:33 -07:00
Paul Banks
0a06215d1a
Documentation for Adaptive Overload Protection (#26690)
* Document enabling config

* Fix nav data JSON after disabling over-zealous prettifier

* Address review feedback

* Add warning about reloading config during overload

* Bad metrics links

* Another bad link

* Add upgrade note about deprecation

---------

Co-authored-by: Mike Palmiotto <mike.palmiotto@hashicorp.com>
2024-05-10 17:55:57 +01:00
CJ
b2580d4212
Add missing integrated storage reference architecture diagram (#26600)
* add missing diagram

* fix path to file

---------

Co-authored-by: Yoko Hyakuna <yoko@hashicorp.com>
2024-04-23 12:07:18 -07:00
CJ
66212d1444
fix key metrics title (#26539) 2024-04-19 11:33:24 -04:00
Brian Shumate
5aaa489f80
Docs: migrate key metrics from WAF to telemetry (#26499)
- Add key metrics document to telemetry internals documentation
2024-04-18 11:45:37 -04:00
JJ
37c5982761
Editorial changes to integrated-storage.mdx (#26416)
Approximately half a dozen fixes to spelling and grammar.

Co-authored-by: Yoko Hyakuna <yoko@hashicorp.com>
2024-04-15 11:51:11 -07:00
Josh Black
6d69761751
raft-wal docs (#25572)
* starting on docs

* add docs for raft-wal

* some tweaks

* Apply suggestions from code review

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

* Edits for Raft WAL (#26123)

* not just one filename

* update file pattern for wal files

---------

Co-authored-by: Mike Palmiotto <mike.palmiotto@hashicorp.com>
Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
2024-03-25 16:42:48 -07:00
Mike Palmiotto
9ddd23cf62
Request Limiter docs (#25557)
Co-authored-by: miagilepner <mia.epner@hashicorp.com>
2024-02-27 16:24:44 -05:00
Scott Miller
da21b85133
Make encryption persistence timeout configurable via env var (#25636)
* Make the encryption tracking persistence timeout configurable via env

* docs

* changelog

* Update vault/barrier_aes_gcm.go

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

* use ParseDurationSecond

---------

Co-authored-by: Steven Clark <steven.clark@hashicorp.com>
2024-02-27 18:04:18 +00:00
Max Coulombe
3b3dc14268
+ added sync telemetry doc (#25555) 2024-02-21 14:06:24 -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
Yoko Hyakuna
af3419940c
[DOCS] Fix page heading (#24835)
* Fix the page header

* Fix the grammar pinted out by PR-1952
2024-01-12 08:03:46 -08:00
miagilepner
0c2a160347
VAULT-21944: add documentation for thousands of namespaces (#24235) 2024-01-09 08:04:18 -05: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
Scott Miller
cd761dfa0a
Document the seal HA metrics and use labels for seal names (#23837)
* Document the seal HA metrics and use labels for seal names

* changelog
2023-10-26 10:07:34 -05:00
Luis (LT) Carbonell
42a141cf34
Update Telemetry Docs (#23535)
* update remote wal docs

* Update website/content/partials/telemetry-metrics/vault/replication/fsm/last_remote_wal.mdx

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

---------

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
2023-10-10 17:00:34 -04:00
Luis (LT) Carbonell
c93137d9a3
Add Reindex In Progress Metric (#23160)
* Add a telemetry metric to track if a reindex is in progress or not

* changelog

* Add other reindex related metrics

* cleanup types

* Add docs for these metrics

* check for nil values
2023-09-22 10:53:26 -04:00
miagilepner
4e3b91d91f
[VAULT-17827] Rollback manager worker pool (#22567)
* workerpool implementation

* rollback tests

* website documentation

* add changelog

* fix failing test
2023-09-04 15:48:09 +02:00
Sarah Chavis
133e9ac793
Add WAF links and remove tip notation from guide (#22710) 2023-09-01 12:51:32 -04:00
miagilepner
616c3a5ba5
[VAULT-17826] Remove mount point from rollback metrics (#22400)
* remove metrics

* add test and documentation

* update docs

* changelog

* fix TestConfig_Sanitized

* Update website/content/docs/upgrading/upgrade-to-1.15.x.mdx

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

* Update website/content/docs/upgrading/upgrade-to-1.15.x.mdx

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

* Update website/content/partials/telemetry-metrics/rollback-intro.mdx

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

* Update website/content/partials/telemetry-metrics/route-intro.mdx

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

* separate partials for metrics

* remove debugging line

* add high cardinality warning

---------

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
2023-08-21 16:55:37 +02:00
Sarah Chavis
ec6fc13c71
Replace "tbd" with a meaningful example (#22022) 2023-08-17 15:21:15 -07:00
Peter Wilson
a53e78699f
Move code block outside of 'tip' to resolving layout issues (#22395)
* Move code block outside of 'tip' to resolving layout issues

* <tip> block requires a newline before content (and likely after)
2023-08-17 13:49:11 +01:00
JD Goins
1f1989333d
Docs: Add metrics for mount table monitoring (#21927)
* Add metrics for mount table monitoring
---------

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
2023-08-16 13:12:29 -07:00
Sarah Chavis
e91b507996
Docs/SPE 260: update and reorganize telemetry metric references (#21965)
New how-to guide to enable telemetry, restructure telemetry metrics as partials, and provide multiple index pages to make them easier to look up.
2023-07-21 10:28:52 -07:00
Paul Banks
def7c1b0a7
Fix drift, these docs are only in ent repo docs so not public (#21941)
* Fix drift, these docs are only in ent repo docs so not public

* Remove newline
2023-07-19 15:17:22 +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
Christopher Swenson
c250c95614
docs: Traditional HA standby nodes do *not* serve read requests directly (#20687) 2023-05-19 13:00:57 -07:00
Josh Black
e9bcff018a
add undo logs metrics to docs (#20568) 2023-05-11 18:28:25 -07:00
mickael-hc
3926057a4f
security model updates (#19656) 2023-03-21 11:14:00 -07:00
Tom Crayford
a23c7e63f9
Docs: Remove duplicated, outdated raft information (#11620)
Co-authored-by: Mehdi Ahmadi <aphorise@gmail.com>
2023-02-08 13:37:54 +00:00
akshya96
73f62ae047
adding emit duration for telemetry (#19027) 2023-02-07 11:26:38 -08:00
Max Winslow
4ed4c44994
docs: Typo (#18541) 2023-02-07 11:35:41 +00:00
Florin Cătălin Țiucra-Popa
cc26d0dcb8
Update integrated-storage.mdx (#18893)
* Update integrated-storage.mdx

The quorum paragraph shall also be updated with the table:
instead of: 
"A Raft cluster of 3 nodes can tolerate a single node failure while a cluster
of 5 can tolerate 2 node failures. The recommended configuration is to either
run 3 or 5 Vault servers per cluster."

shall be:
"A Raft cluster of 3 nodes can tolerate a single node failure while a cluster
of 5 can tolerate 2 node failures. The recommended configuration is to either
run 5 or 7 Vault servers per cluster."

* Give an explicit node recommendation

---------

Co-authored-by: Yoko Hyakuna <yoko@hashicorp.com>
2023-01-31 12:19:28 -08: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
akshya96
dc95733f57
user-lockout documentation changes (#18478)
* added user-lockout documentation changes

* add changelog

* remove new lines

* changing method name

* changing lockedusers to locked-users

* Update website/content/docs/concepts/user-lockout.mdx

Co-authored-by: Meggie <meggie@hashicorp.com>

* Update website/content/api-docs/system/user-lockout.mdx

Co-authored-by: Meggie <meggie@hashicorp.com>

* Update website/content/api-docs/system/user-lockout.mdx

Co-authored-by: Meggie <meggie@hashicorp.com>

* Update website/content/partials/user-lockout.mdx

Co-authored-by: Meggie <meggie@hashicorp.com>

* Update website/content/partials/user-lockout.mdx

Co-authored-by: Meggie <meggie@hashicorp.com>

* adding suggested changes

* adding bullet points to disable

* Update website/content/api-docs/system/user-lockout.mdx

Co-authored-by: Josh Black <raskchanky@users.noreply.github.com>

* Update website/content/partials/user-lockout.mdx

Co-authored-by: Josh Black <raskchanky@users.noreply.github.com>

* Update website/content/docs/commands/auth/tune.mdx

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

* Update website/content/docs/commands/auth/tune.mdx

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

* Update website/content/docs/concepts/user-lockout.mdx

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

Co-authored-by: Meggie <meggie@hashicorp.com>
Co-authored-by: Josh Black <raskchanky@users.noreply.github.com>
Co-authored-by: Mike Palmiotto <mike.palmiotto@hashicorp.com>
2023-01-17 15:12:16 -08:00
Florin Cătălin Țiucra-Popa
308c726d4d
Update integrated-storage.mdx (#18581)
* Update integrated-storage.mdx

The old paragraph "The recommended deployment is either 3 or 5 servers." should match the "Minimums & Scaling" purpose from below.
It also reaffirms that, in a PRODUCTION environment,  a number of 5 nodes are the minimum requirement.

A rewording is also necessary: "The recommended deployment consists in a minimum of 5 or more of servers that are odd in their total (5, 7, etc)."

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

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

Co-authored-by: Yoko Hyakuna <yoko@hashicorp.com>
2023-01-04 13:43:05 +01:00
divyaac
9fd4203d2e
Edit Telemetry Docs (#17209) 2022-10-19 12:13:32 -07:00
Bryce Kalow
47875daf53
website: fixes redirected links (#17574)
* fixes redirected links

* fix broken link to key wrapping guide
2022-10-18 14:06:27 -04:00
Nick Cabatoff
ce74f4f1de
Add more raft metrics, emit more metrics on non-perf standbys (#12166)
Add some metrics helpful for monitoring raft cluster state.

Furthermore, we weren't emitting bolt metrics on regular (non-perf) standbys, and there were other metrics
in metricsLoop that would make sense to include in OSS but weren't.  We now have an active-node-only func,
emitMetricsActiveNode.  This runs metricsLoop on the active node.  Standbys and perf-standbys run metricsLoop
from a goroutine managed by the runStandby rungroup.
2022-10-07 09:09:08 -07: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
Yoko Hyakuna
b0fa0edbdd
Remove extra spaces in the table (#17257) 2022-09-21 08:42:51 -07:00
Hamid Ghaf
3eafec8f45
adding missing telemetry entry for cached auth response (#17197) 2022-09-19 14:08:39 -04:00
Troy Ready
7f22056686
Minor doc grammar update (#17032)
Update to clarify present perfect tense.
2022-09-07 10:04:18 -04:00
André Freitas
cfe3c61dce
Fix typos in architecture page (#16978)
Some minor typos fix after I read the whole page.
2022-09-01 12:02:50 -07:00
Andy Assareh
2803cbe117
Doc only: Dead Server Cleanup added in Vault 1.7 (#14297) 2022-08-31 08:34:47 -04:00
Brian Shumate
24bb6c2280
Docs: Update Internals > Telemetry (#9323)
* Docs: Update Internals > Telemetry

- More clarification and detail around vault.core.leadership_lost

* Update website/pages/docs/internals/telemetry.mdx

Co-authored-by: Mark Gritter <mgritter@hashicorp.com>

* Docs: Telemetry vault.core.leadership_lost

Improved text reading.

* Update website/pages/docs/internals/telemetry.mdx

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

* Docs: Telemetry vault.core.leadership_lost clarity.

Co-authored-by: Mark Gritter <mgritter@hashicorp.com>
Co-authored-by: aphorise <aphorise@gmail.com>
Co-authored-by: Loann Le <84412881+taoism4504@users.noreply.github.com>
2022-08-26 16:48:38 -07:00
Loann Le
d8d7f2c276
vault documentation: doc cleanup effort-batch5 (#16913)
* clean up efforts

* clean up effort

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

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

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

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

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

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

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

Co-authored-by: Yoko Hyakuna <yoko@hashicorp.com>
2022-08-26 15:48:56 -07:00
Alexander Scheel
6e6914547e
Let PKI tidy associate revoked certs with their issuers (#16871)
* Refactor tidy steps into two separate helpers

This refactors the tidy go routine into two separate helpers, making it
clear where the boundaries of each are: variables are passed into these
method and concerns are separated. As more operations are rolled into
tidy, we can continue adding more helpers as appropriate. Additionally,
as we move to make auto-tidy occur, we can use these as points to hook
into periodic tidying.

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

* Refactor revInfo checking to helper

This allows us to validate whether or not a revInfo entry contains a
presently valid issuer, from the existing mapping. Coupled with the
changeset to identify the issuer on revocation, we can begin adding
capabilities to tidy to update this association, decreasing CRL build
time and increasing the performance of OCSP.

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

* Refactor issuer fetching for revocation purposes

Revocation needs to gracefully handle using the old legacy cert bundle,
so fetching issuers (and parsing them) needs to be done slightly
differently than other places. Refactor this from revokeCert into a
common helper that can be used by tidy.

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

* Allow tidy to associate revoked certs, issuers

When revoking a certificate, we need to associate the issuer that signed
its certificate back to the revInfo entry. Historically this was
performed during CRL building (and still remains so), but when running
without CRL building and with only OCSP, performance will degrade as the
issuer needs to be found each time.

Instead, allow the tidy operation to take over this role, allowing us to
increase the performance of OCSP and CRL in this scenario, by decoupling
issuer identification from CRL building in the ideal case.

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

* Add tests for tidy updates

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

* Add changelog entry

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

* Add documentation on new tidy parameter, metrics

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

* Refactor tidy config into shared struct

Finish adding metrics, status messages about new tidy operation.

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

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>
2022-08-26 10:13:45 -07:00
aphorise
a98e94fb80
Docs: Integrated Storage & Raft protocol clarity - minor edit. (#16828) 2022-08-26 11:24:59 -04:00