vault/website/content/docs/configuration/adaptive-overload-protection.mdx
Paul Banks 0a06215d1a
Documentation for Adaptive Overload Protection (#26690)
* Document enabling config

* Fix nav data JSON after disabling over-zealous prettifier

* Address review feedback

* Add warning about reloading config during overload

* Bad metrics links

* Another bad link

* Add upgrade note about deprecation

---------

Co-authored-by: Mike Palmiotto <mike.palmiotto@hashicorp.com>
2024-05-10 17:55:57 +01:00

46 lines
1.3 KiB
Plaintext

---
layout: docs
page_title: Adaptive overload protection - Configuration
description: |-
Use adaptive overload protection with Vault Enterprise to automatically
prevent workloads from overloading different resources of your Vault servers.
---
# `adaptive_overload_protection`
@include 'alerts/enterprise-only.mdx'
@include 'alerts/beta.mdx'
Configure the `adaptive_overload_protection` stanza to control overload
protection features for your Vault server.
@include 'config-reload-supported.mdx'
<Warning title="Do not disable during overload">
Do not disable the adaptive overload protection features during an overload.
This feature is designed to protect your Vault server from overload conditions.
Disabling it can lead to poor availability.
</Warning>
For more information read [Adaptive Overload
Protection](/vault/docs/concepts/adaptive-overload-protection).
```hcl
adaptive_overload_protection {
disable_write_controller = false
}
```
## `adaptive_overload_protection` parameters
These parameters apply to the `adaptive_overload_protection` stanza in the Vault
configuration file:
- `disable_write_controller` `(bool: <optional>)`: Disables the adaptive write
overload controller. Defaults to `true` (controller disabled). Set
`disable_write_controller` to `false` to enable the write controller and opt
in to the beta functionality.