Key/value file-based store storage plugin (proto)

extensions.key_value.file_based.v3.FileBasedKeyValueStoreConfig

[extensions.key_value.file_based.v3.FileBasedKeyValueStoreConfig proto]

This is configuration to flush a key value store out to disk.

Warning

This API feature is currently work-in-progress. API features marked as work-in-progress are not considered stable, are not covered by the threat model, are not supported by the security team, and are subject to breaking changes. Do not use this feature without understanding each of the previous points.

This extension has the qualified name envoy.key_value.file_based

Note

This extension is functional but has not had substantial production burn time, use only with this caveat.

This extension does not operate on the data plane and hence is intended to be robust against untrusted traffic.

Tip

This extension extends and can be used with the following extension category:

envoy.common.key_value

This extension must be configured with one of the following type URLs:

type.googleapis.com/envoy.extensions.key_value.file_based.v3.FileBasedKeyValueStoreConfig

{
  "filename": ...,
  "flush_interval": {...},
  "max_entries": {...}
}

filename: (string, REQUIRED) The filename to read the keys and values from, and write the keys and values to.

flush_interval: (Duration) The interval at which the key value store should be flushed to the file.

max_entries: (UInt32Value) The maximum number of entries to cache, or 0 to allow for unlimited entries. Defaults to 1000 if not present.