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

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

Merged
merged 5 commits into from
Aug 31, 2022
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c5d1ca9
VAULT-7707 Add docs around making mass amounts of lease count quotas …
VioletHynes Aug 31, 2022
2dd0a10
VAULT-7707 Changelog
VioletHynes Aug 31, 2022
5830ed4
VAULT-7707 add word
VioletHynes Aug 31, 2022
1e08c03
VAULT-7707 Update some small wordings
VioletHynes Aug 31, 2022
eecba7a
VAULT-7707 use a real em dash
VioletHynes Aug 31, 2022
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
3 changes: 3 additions & 0 deletions changelog/16950.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```release-note:improvement
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't need changelogs for changes that don't impact the binary.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, woops. I did a quick check to see if there were docs changelogs and there were some. Should I remove it, or leave it in?

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
View file
Open in desktop
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