Skip to content

Commit

Permalink
VAULT-7707 Add docs around making mass amounts of lease count quotas …
Browse files Browse the repository at this point in the history
…via automation (#16950)

* VAULT-7707 Add docs around making mass amounts of lease count quotas via automation

* VAULT-7707 Changelog

* VAULT-7707 add word

* VAULT-7707 Update some small wordings

* VAULT-7707 use a real em dash
  • Loading branch information
VioletHynes authored Aug 31, 2022
1 parent 4dc8155 commit 42645c0
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 0 deletions.
3 changes: 3 additions & 0 deletions changelog/16950.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```release-note:improvement
website/docs: Add documentation around the expensiveness of making lots of lease count quotas in a short period
```
8 changes: 8 additions & 0 deletions website/content/api-docs/system/lease-count-quotas.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,14 @@ A lease count quota must include a `max_leases` value with an optional `path`
that can either be a namespace or mount, and can optionally include a path suffix following
the mount to restrict more specific API paths.

Upon creating a lease count quota, it will be populated with the current count of leases from this path. If there are
more leases present than the specified `max_leases`, this will cause the lease count to go over the specified
`max_leases`.

The initial population process can cause a lot of work for Vault - and while creating one lease count quota
is always fine, if you're planning to create — for example — thousands of lease count quotas for paths with
millions of leases in an automated way, it is recommended to space out the creation requests.

| Method | Path |
| :----- | :------------------------------ |
| `POST` | `/sys/quotas/lease-count/:name` |
Expand Down

0 comments on commit 42645c0

Please sign in to comment.