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

docs: add a warning about caching and updates #117

Merged
merged 2 commits into from
Aug 20, 2024
Merged

docs: add a warning about caching and updates #117

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
375b612
docs: add a warning about caching and updates
creachadair Aug 20, 2024
81a5df7
typo
creachadair Aug 20, 2024
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
18 changes: 18 additions & 0 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -485,6 +485,24 @@ the program's secret values to local storage, which means they can be read by
program can start up immediately using cached data, even if the secrets server
is not reachable when it launches.

> [!WARNING]
> When you enable a secrets cache for a program, new secret values may not
> immediately become available even if the program is restarted. By design, if
> a cached value is available at startup, the store does not wait for the
> secrets service to respond before delivering the initial (cached) value.
>
> The store will see the new value (and update the cache) the next time it
> successfully polls. If the program only looks at the initial value of the
> secret, however, it will not see the new value until it is restarted _after_
> the next update.
>
> As a general rule, we recommend you _not_ enable a cache unless the program
> cannot tolerate even a temporary outage of the secrets service or your
> tailnet at program start (for example, if it is part of your infrastructure
> bootstrap). If you _must_ use a cache, we advise you structure your program
> to automatically handle new secret values, and not to "lock in" the initial
> value of a secret when the program starts up. You may also wish to decrease
> the polling interval from the default.

## Self-Contained Operation

Expand Down
Loading