From 2fb4ed211d46fa188f91df73200eb7cd0a8d758f Mon Sep 17 00:00:00 2001 From: Violet Hynes Date: Wed, 31 Aug 2022 11:50:01 -0400 Subject: [PATCH] VAULT-7707 Add docs around making mass amounts of lease count quotas 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 --- changelog/16950.txt | 3 +++ website/content/api-docs/system/lease-count-quotas.mdx | 8 ++++++++ 2 files changed, 11 insertions(+) create mode 100644 changelog/16950.txt diff --git a/changelog/16950.txt b/changelog/16950.txt new file mode 100644 index 000000000..0ee2d5bdc --- /dev/null +++ b/changelog/16950.txt @@ -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 +``` diff --git a/website/content/api-docs/system/lease-count-quotas.mdx b/website/content/api-docs/system/lease-count-quotas.mdx index 0f28cc936..66d588f7f 100644 --- a/website/content/api-docs/system/lease-count-quotas.mdx +++ b/website/content/api-docs/system/lease-count-quotas.mdx @@ -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` |