scottk/vault
1
0
Fork 0
mirror of https://github.com/optim-enterprises-bv/vault.git synced 2025-10-29 17:52:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

VAULT-24385 docs updates for proxy static secret caching -> ent (#25677)

Browse Source 
* VAULT-24385 docs updates for proxy static secret caching -> ent

* VAULT-24385 we -> you
This commit is contained in:
Violet Hynes
2024-02-28 10:28:51 -05:00
committed by GitHub
parent fc559052c7
commit 5e42f9a8d3
3 changed files with 18 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
changelog/23621.txt
View File

@@ -1,3 +1,3 @@
```release-note:feature ```release-note:feature
**Vault Proxy Static Secret Caching**: Adds support for static secret (KVv1 and KVv2) caching to Vault Proxy. **Vault Proxy Static Secret Caching (enterprise)**: Adds support for static secret (KVv1 and KVv2) caching to Vault Proxy.
``` ```

16
website/content/docs/agent-and-proxy/proxy/caching/static-secret-caching.mdx
View File

@@ -8,19 +8,25 @@ description: |-
# Vault Proxy static secret caching # Vault Proxy static secret caching
@include 'alerts/enterprise-only.mdx'
Use static secret caching with Vault Proxy to cache KVv1 and KVv2 secrets to Use static secret caching with Vault Proxy to cache KVv1 and KVv2 secrets to
minimize requests made to Vault and provide resilient connections for clients. minimize requests made to Vault and provide resilient connections for clients.
Vault Proxy utilizes the Enterprise only [Vault event notification system](/vault/docs/concepts/events)
feature for cache freshness. As a result, static secret caching can only be used
with Vault Enterprise installations.
## Step 1: Subscribe Vault Proxy to KV events ## Step 1: Subscribe Vault Proxy to KV events
Vault Proxy uses Vault events and auto-auth to monitor secret status and make Vault Proxy uses Vault events and auto-auth to monitor secret status and make
appropriate cache updates. appropriate cache updates.
1. Enable [auto-auth](/vault/docs/agent-and-proxy/autoauth). 1. Enable [auto-auth](/vault/docs/agent-and-proxy/autoauth).
1. Create an auto-auth token with permission to subscribe to KV event updates 1. Create an auto-auth token with permission to subscribe to KV event updates
with the [Vault event system](/vault/docs/concepts/events). For example, to with the [Vault event notification system](/vault/docs/concepts/events). For
create a policy that grants access to static secret (KVv1 and KVv2) events, example, to create a policy that grants access to static secret (KVv1 and KVv2)
we need permission to subscribe to the `events` endpoint, as well as the events, you need permission to subscribe to the `events` endpoint, as well as
`list` and `subscribe` permissions on KV secrets we want to get secrets the `list` and `subscribe` permissions on KV secrets you want to get secrets
from: from:
```hcl ```hcl
path "sys/events/subscribe/kv*" { path "sys/events/subscribe/kv*" {
@@ -80,7 +86,7 @@ success `GET` request. If the request is successful, Proxy caches the fact that
the token was successful in addition to the result. Subsequent requests by the the token was successful in addition to the result. Subsequent requests by the
same token can then access this secret from the cache instead of Vault. same token can then access this secret from the cache instead of Vault.
Vault Proxy uses the [event system](/vault/docs/concepts/events) to keep the Vault Proxy uses the [event notification system](/vault/docs/concepts/events) to keep the
cache up to date. It monitors the KV event feed for events related to any secret cache up to date. It monitors the KV event feed for events related to any secret
currently stored in the cache, including modification events like updates and currently stored in the cache, including modification events like updates and
deletes. When Proxy detects a change in a cached secret, it will update or deletes. When Proxy detects a change in a cached secret, it will update or

7
website/data/docs-nav-data.json
View File

@@ -1198,7 +1198,12 @@
}, },
{ {
"title": "Static Secret Caching", "title": "Static Secret Caching",
"path": "agent-and-proxy/proxy/caching/static-secret-caching" "path": "agent-and-proxy/proxy/caching/static-secret-caching",
"badge": {
"text": "ENTERPRISE",
"type": "outlined",
"color": "neutral"
}
}, },
{ {
"title": "Persistent Caching", "title": "Persistent Caching",