Aegis documentation

#Redis

The Redis cube owns the cache the panel and the applications share. It renders aegis-redis.conf (mode 0640) under redis.config_dir (/aegis/config/redis), keeps the RDB snapshot in redis.data_dir, and the pid, Unix socket and log in redis.run_dir and redis.log_dir. The server listens on loopback (redis.port, default 6379) and writes a socket at run/redis/redis.sock for local clients. There is no database of its own; everything lives in the dump file.

Memory is capped by redis.maxmemory (default 256mb) with redis.maxmemory_policy (default allkeys-lru). The server runs as the keeper service aegis-redis under the redis.user account.

#Common commands

Cube operations share one wrapper: ✔ redis: <detail> on success, ✖ <message> on failure (exit 1), and {"ok": true, "cube": "redis", "result": "<detail>"} with global --json.

expose is the only verb that prints a block instead of that line.

VerbEffect
configurecreate the account, render the configuration, set ownership, start when stopped, validate
validaterun redis-cli -p <port> ping and require PONG
reloadrestart; Redis reads its configuration only at startup
statusread run/redis/redis.pid: running (pid N) or stopped
startstart the server through the keeper
stopSIGTERM, then SIGKILL after 15 seconds
restartstop, then start
exposeprint config, data, port and socket paths, then publish the Redis tools
helpprint the command list with examples

#configure

bash
aegis cubes redis configureaegis --json cubes redis configure
text
✔ redis: server answers ping{"ok": true, "cube": "redis", "result": "server answers ping"}

#validate

bash
aegis cubes redis validateaegis --json cubes redis validate

A server that is up but does not answer PONG is reported as redis is not answering, with the last six lines of the client output.

text
✔ redis: server answers ping{"ok": true, "cube": "redis", "result": "server answers ping"}

#reload

bash
aegis cubes redis reloadaegis --json cubes redis reload

Restarts the server. Any change to redis.maxmemory or the policy needs this, not validate. A stopped server fails with redis is not running.

text
✔ redis: stopped (pid 1801), started (pid 1822){"ok": true, "cube": "redis", "result": "stopped (pid 1801), started (pid 1822)"}

#status

bash
aegis cubes redis statusaegis --json cubes redis status
text
✔ redis: running (pid 1801){"ok": true, "cube": "redis", "result": "running (pid 1801)"}

#start

bash
aegis cubes redis startaegis --json cubes redis start
text
✔ redis: started (pid 1801){"ok": true, "cube": "redis", "result": "started (pid 1801)"}

#stop

bash
aegis cubes redis stopaegis --json cubes redis stop

A graceful shutdown writes the RDB snapshot before exiting, so cached data that is not persisted yet is saved.

text
✔ redis: stopped (pid 1801){"ok": true, "cube": "redis", "result": "stopped (pid 1801)"}

#restart

bash
aegis cubes redis restartaegis --json cubes redis restart
text
✔ redis: stopped (pid 1801), started (pid 1843){"ok": true, "cube": "redis", "result": "stopped (pid 1801), started (pid 1843)"}

#expose

bash
aegis cubes redis exposeaegis --json cubes redis expose
text
cube           redisinstalled      /aegis/apps/data/redis/8.10configuration  /aegis/config/redisstate          running (pid 1801)pid            1801log            /aegis/logs/redis/redis.logconfig         /aegis/config/redis/aegis-redis.confdata           /aegis/data/redisport           6379socket         /aegis/run/redis/redis.sockpublished      /aegis/bin/redis-server, /aegis/bin/redis-cli, /aegis/bin/redis-benchmark
text
{"ok": true, "cube": "redis", "installed": "/aegis/apps/data/redis/8.10", "configuration": "/aegis/config/redis", "state": "running (pid 1801)", "pid": "1801", "log": "/aegis/logs/redis/redis.log", "config": "/aegis/config/redis/aegis-redis.conf", "data": "/aegis/data/redis", "port": "6379", "socket": "/aegis/run/redis/redis.sock", "published": "/aegis/bin/redis-server, /aegis/bin/redis-cli, /aegis/bin/redis-benchmark"}

#help

bash
aegis cubes redis helpaegis cubes help redis
text
ℹ Redis — Redis cache with its own data directoryCommands  validate   Check the configuration  reload     Reload the running daemon  configure  Write the configuration and validate it  start      Start the server  stop       Stop the server  status     Show whether the server runs  restart    Restart the server  expose     Show where it is installed and how it runs  help       Show every command with examples

The examples block follows.