docs: adds documentation about provider response caching #2927
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sozercan
reviewed
Aug 3, 2023
website/docs/externaldata.md
Outdated
| @@ -146,6 +146,9 @@ If there is a system error, the provider should return the system error message | |||
|
|
|||
| Example provider implementation: https://github.com/open-policy-agent/gatekeeper/blob/master/test/externaldata/dummy-provider/provider.go | |||
|
|
|||
| #### Caching | |||
| Gatekeeper now supports caching of responses from external data providers. It caches the response based on the `Key` and `Value` received as part of the [`ProviderResponse`](#providerresponse). By default, the cache is invalidated after 3 minutes, which is the default Time-to-Live (TTL). You can configure the TTL using the --external-data-provider-response-cache-ttl flag. | |||
There was a problem hiding this comment.
Suggested change
| Gatekeeper now supports caching of responses from external data providers. It caches the response based on the `Key` and `Value` received as part of the [`ProviderResponse`](#providerresponse). By default, the cache is invalidated after 3 minutes, which is the default Time-to-Live (TTL). You can configure the TTL using the --external-data-provider-response-cache-ttl flag. | |
| Starting with v3.13+, Gatekeeper supports caching of responses from external data providers. It caches the response based on the `Key` and `Value` received as part of the [`ProviderResponse`](#providerresponse). By default, the cache is invalidated after 3 minutes, which is the default Time-to-Live (TTL). You can configure the TTL using the `--external-data-provider-response-cache-ttl` flag. |
There was a problem hiding this comment.
Do we want to give the version when a feature arrives? Is that implicit in the versioning of docs?
Definitely prefer listing a specific version to "now supports"
There was a problem hiding this comment.
+1 on adding something like, similar to how we have been communicating feature status and GK versions
Feature State: Gatekeeper version v3.11+ (beta)
There was a problem hiding this comment.
I added Starting with v3.13+, Gatekeeper supports... per @sozercan suggestion. Does that work?
sozercan
reviewed
Aug 3, 2023
maxsmythe
reviewed
Aug 5, 2023
website/docs/externaldata.md
Outdated
| @@ -146,6 +146,9 @@ If there is a system error, the provider should return the system error message | |||
|
|
|||
| Example provider implementation: https://github.com/open-policy-agent/gatekeeper/blob/master/test/externaldata/dummy-provider/provider.go | |||
|
|
|||
| #### Caching | |||
| Gatekeeper now supports caching of responses from external data providers. It caches the response based on the `Key` and `Value` received as part of the [`ProviderResponse`](#providerresponse). By default, the cache is invalidated after 3 minutes, which is the default Time-to-Live (TTL). You can configure the TTL using the --external-data-provider-response-cache-ttl flag. | |||
There was a problem hiding this comment.
Do we want to give the version when a feature arrives? Is that implicit in the versioning of docs?
Definitely prefer listing a specific version to "now supports"
ritazh
reviewed
Aug 10, 2023
nilekhc
force-pushed
the
edrc-doc-update
branch
from
b189d28
to
8103cd9
Compare
sozercan
reviewed
Aug 29, 2023
ritazh
approved these changes
Aug 29, 2023
nilekhc
force-pushed
the
edrc-doc-update
branch
from
8103cd9
to
cde6f82
Compare
Signed-off-by: Nilekh Chaudhari <[email protected]>
nilekhc
force-pushed
the
edrc-doc-update
branch
from
cde6f82
to
7b6f44d
Compare
JonnieDoe
pushed a commit
to JonnieDoe/gatekeeper
that referenced
this pull request
Sep 7, 2023
…-agent#2927) Signed-off-by: Nilekh Chaudhari <[email protected]> Signed-off-by: DC ground <[email protected]>
salaxander
pushed a commit
to salaxander/gatekeeper
that referenced
this pull request
Sep 13, 2023
…-agent#2927) Signed-off-by: Nilekh Chaudhari <[email protected]>
Mattes83
pushed a commit
to Mattes83/gatekeeper
that referenced
this pull request
Oct 25, 2023
…-agent#2927) Signed-off-by: Nilekh Chaudhari <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does / why we need it:
Which issue(s) this PR fixes (optional, using
fixes #<issue number>(, fixes #<issue_number>, ...)format, will close the issue(s) when the PR gets merged):Fixes #
Special notes for your reviewer: