Skip to content

Commit

Permalink
Add missing documentation on cert metrics (#21073)
Browse files Browse the repository at this point in the history
Signed-off-by: Alexander Scheel <[email protected]>
  • Loading branch information
cipherboy committed Jun 8, 2023
1 parent f44481e commit 4451296
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions website/content/api-docs/secret/pki.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3898,6 +3898,21 @@ The below parameters are in addition to the regular parameters accepted by the
operations; note that this is from the end of one operation to the start of
the next so the time of the operation itself does not need to be considered.

- `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

0 comments on commit 4451296

Please sign in to comment.