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

Jump to bottom

docs: agent cache config requirements #13006

Merged
merged 3 commits into from
Nov 2, 2021
Merged

docs: agent cache config requirements #13006

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4e1d951
docs: agent cache config requirements
tvoran Nov 1, 2021
b9e29d5
Merge remote-tracking branch 'origin/main' into docs/VAULT-3849/agent…
tvoran Nov 1, 2021
e8152ca
Update website/content/docs/agent/caching/index.mdx
tvoran Nov 2, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
11 changes: 9 additions & 2 deletions website/content/docs/agent/caching/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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" {...}`.

Expand All @@ -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`)

Expand Down