Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add missing documentation on cert metrics #21073

Merged
merged 1 commit into from
Jun 8, 2023
Merged

Add missing documentation on cert metrics #21073

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions website/content/api-docs/secret/pki.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4310,6 +4310,21 @@ The below parameters are in addition to the regular parameters accepted by the
the next so the time of the operation itself does not need to be considered.
Defaults to 12h

- `maintain_stored_certificate_counts` `(bool: false)` - When enabled,
maintains expensive counts of certificates. During initialization of the
mount, a LIST of all certificates is performed to get a baseline figure and
throughout operations like issuance, revocation, and subsequent tidies, the
figure is updated.

~> *Note*: It is strongly recommend to not enable this value if 50k or more
certificates are stored in the mount or if many PKI mounts are in use in
this cluster. Instead, use audit logs and aggregate this data externally
to Vault so as not to impact Vault performance.

- `publish_stored_certificate_count_metrics` `(bool: false)` - When enabled,
publishes the value computed by `maintain_stored_certificate_counts` to
the mount's metrics. This requires the former to be enabled.

#### Sample Payload

```json
Expand Down