Skip to main content Link Search Menu Expand Document (external link)

Database access

Everyone can access the Redis database with read-only privileges. The Redis user default (password is not important) can be used for this purpose.

To get write access a module must provide the Redis credentials stored in its agent.env file. The complete path is ~/.config/state/agent.env. Write access is restricted to Redis keys and channels with prefix module/{module_id}/*. The same credentials allow read access of keys with the same prefix.

The above rules are already implemented by the Python agent module.

Access Redis in read-only:

import agent

rdb = agent.redis_connect(privileged=False)
somehash = rdb.hgetall('cluster/somehash')

Access Redis in read-write mode:

import agent

rdb = agent.redis_connect(privileged=True)
rdb.hset('module/myapp1/myhash', mapping={'myvar': 'myvalue'})