luxolus
/
open-vault
2
0
Fork 0
Code Issues 1 Pull Requests Releases Activity

docs: agent cache config requirements (#13006) 

Added a note that agent cache requires at least one listener or template
to be defined in the config, and a couple spelling corrections.

Co-authored-by: Tom Proctor <tomhjp@users.noreply.github.com>
This commit is contained in:
Theron Voran 2021-11-02 11:29:40 -07:00 committed by GitHub
parent ebb904031f
commit 3277b8441e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
website/content/docs/agent/caching/index.mdx
View File

@ -211,11 +211,18 @@ page.
- `when_inconsistent` `(string: optional)` - Set to one of `"fail"`, `"retry"`,
or `"forward"`.
-> **Note:** When the `cache` block is defined, at least one
[template][agent-template] or [listener][agent-listener] must also be defined
in the config, otherwise there is no way to utilize the cache.
[agent-template]: /docs/agent/template
[agent-listener]: /docs/agent/caching#configuration-listener
### Configuration (Persist)
These are common configuration values that live within the `persist` block:
- `type` `(string: required)` - The type of the persistent cahce to use,
- `type` `(string: required)` - The type of the persistent cache to use,
e.g. `kubernetes`. _Note_: when using HCL this can be used as the key for
the block, e.g. `persist "kubernetes" {...}`.
@ -226,7 +233,7 @@ These are common configuration values that live within the `persist` block:
is not deleted. Defaults to `false`.
- `exit_on_err` `(bool: optional)` - When set to true, if any errors occur during
a persitent cache restore, Vault Agent will exit with an error. Defaults to `true`.
a persistent cache restore, Vault Agent will exit with an error. Defaults to `true`.
## Configuration (`listener`)