This capability provider implements the wasmcloud:keyvalue capability contract with a Redis back-end. It is multi-threaded and can handle concurrent requests from multiple actors. Each link definition declared for this provider will result in a single Redis connection managed on behalf of the linked actor. Connections are maintained within the provider process, so multiple instances of this provider running in the same lattice will not share connections.
If you want multiple actors to share the same keyspace/database then you will need to provide the same Redis URL for multiple link definitions (or utilize start-up configuration as discussed below).
The easiest way to use this provider is to pass wasmcloud.azurecr.io/kvredis:0.19.0 (or newer, check the badge at the top of this README) as the OCI reference parameter to a wash/lattice control "start provider" command.
wash ctl start provider wasmcloud.azurecr.io/kvredis:0.19.0For the latest OCI reference URLs for all capability providers, see the root of the capability-providers repository.
The following is a list of configuration settings available in the link definition.
| Property | Description |
|---|---|
URL |
The connection string URL for the Redis database. Note that all authentication information must also be contained in this URL. The URL must start with the redis:// scheme. Example: redis://127.0.0.1:6379 |
This provider also accepts a default URL as a configuration value on startup. If this value is supplied, then this URL will be used for actors linked with no values (you must still link the actor to the provider, even if there is no data). URLs defined in link definitions take priority over the default URL.
To supply the startup configuration, you can use wash to pass the config-json parameter to the start command:
wash ctl start provider wasmcloud.azurecr.io/kvredis:0.19.0 --config-json /path/to/config.jsonThe JSON expected by the provider is an object with a single url field:
{ "url": "redis://127.0.0.1:6379" }Note that this URL, like link definition URLs, must also use the URL scheme redis://