File cache - Mirage

The file cache keeps file content Mirage has read, so a second read is served without asking the backend again.

`type`	Keeps it	Keys
`ram`	In the process’s memory, up to `limit`	`limit`, default `512MB`; `max_drain_bytes`
`redis`	On Redis, under the workspace’s own keys	`url`, `key_prefix`, `limit`, `max_drain_bytes`

limit is in bytes or a size string. max_drain_bytes is the largest file a streamed read copies into the cache: 8 MiB or limit, whichever is smaller, and never more than limit. The key is cache, beside store rather than inside it.

In memory

YAML
Python
TypeScript

cache:
  type: ram
  limit: 2GB

from mirage import Workspace
from mirage.cache.file.config import CacheConfig

ws = Workspace(mounts, cache=CacheConfig(limit="2GB"))

import { Workspace } from '@struktoai/mirage-node'

const ws = new Workspace(mounts, { cache: { type: 'ram', limit: '2GB' } })

On Redis

With the cache on Redis, a file one instance of the workspace read is served to the others without asking the backend again.

YAML
Python
TypeScript

workspace_id: agent
cache:
  type: redis
  url: redis://redis.internal:6379/0

from mirage import Workspace
from mirage.cache.file.config import RedisCacheConfig

ws = Workspace(
    mounts,
    workspace_id="agent",
    cache=RedisCacheConfig(url="redis://redis.internal:6379/0"),
)

import { Workspace } from '@struktoai/mirage-node'

const ws = new Workspace(mounts, {
  workspaceId: 'agent',
  cache: { type: 'redis', url: 'redis://redis.internal:6379/0' },
})

The keys belong to the workspace, so two workspaces on one Redis never read each other’s files. Naming the same key_prefix in several workspaces shares one cache between them, which is safe only when they mount the same backends at the same paths. On Redis, limit does not evict anything; cap the server’s memory with maxmemory instead.