mirror of
https://github.com/meta-llama/llama-stack.git
synced 2025-10-23 16:37:28 +00:00
2c43285e22
**This PR changes configurations in a backward incompatible way.**
Run configs today repeat full SQLite/Postgres snippets everywhere a
store is needed, which means duplicated credentials, extra connection
pools, and lots of drift between files. This PR introduces named storage
backends so the stack and providers can share a single catalog and
reference those backends by name.
## Key Changes
- Add `storage.backends` to `StackRunConfig`, register each KV/SQL
backend once at startup, and validate that references point to the right
family.
- Move server stores under `storage.stores` with lightweight references
(backend + namespace/table) instead of full configs.
- Update every provider/config/doc to use the new reference style;
docs/codegen now surface the simplified YAML.
## Migration
Before:
```yaml
metadata_store:
type: sqlite
db_path: ~/.llama/distributions/foo/registry.db
inference_store:
type: postgres
host: ${env.POSTGRES_HOST}
port: ${env.POSTGRES_PORT}
db: ${env.POSTGRES_DB}
user: ${env.POSTGRES_USER}
password: ${env.POSTGRES_PASSWORD}
conversations_store:
type: postgres
host: ${env.POSTGRES_HOST}
port: ${env.POSTGRES_PORT}
db: ${env.POSTGRES_DB}
user: ${env.POSTGRES_USER}
password: ${env.POSTGRES_PASSWORD}
```
After:
```yaml
storage:
backends:
kv_default:
type: kv_sqlite
db_path: ~/.llama/distributions/foo/kvstore.db
sql_default:
type: sql_postgres
host: ${env.POSTGRES_HOST}
port: ${env.POSTGRES_PORT}
db: ${env.POSTGRES_DB}
user: ${env.POSTGRES_USER}
password: ${env.POSTGRES_PASSWORD}
stores:
metadata:
backend: kv_default
namespace: registry
inference:
backend: sql_default
table_name: inference_store
max_write_queue_size: 10000
num_writers: 4
conversations:
backend: sql_default
table_name: openai_conversations
```
Provider configs follow the same pattern—for example, a Chroma vector
adapter switches from:
```yaml
providers:
vector_io:
- provider_id: chromadb
provider_type: remote::chromadb
config:
url: ${env.CHROMADB_URL}
kvstore:
type: sqlite
db_path: ~/.llama/distributions/foo/chroma.db
```
to:
```yaml
providers:
vector_io:
- provider_id: chromadb
provider_type: remote::chromadb
config:
url: ${env.CHROMADB_URL}
persistence:
backend: kv_default
namespace: vector_io::chroma_remote
```
Once the backends are declared, everything else just points at them, so
rotating credentials or swapping to Postgres happens in one place and
the stack reuses a single connection pool.
70 lines
2.3 KiB
Python
70 lines
2.3 KiB
Python
# Copyright (c) Meta Platforms, Inc. and affiliates.
|
|
# All rights reserved.
|
|
#
|
|
# This source code is licensed under the terms described in the LICENSE file in
|
|
# the root directory of this source tree.
|
|
|
|
from typing import Annotated, cast
|
|
|
|
from pydantic import Field
|
|
|
|
from llama_stack.core.storage.datatypes import (
|
|
PostgresSqlStoreConfig,
|
|
SqliteSqlStoreConfig,
|
|
SqlStoreReference,
|
|
StorageBackendConfig,
|
|
StorageBackendType,
|
|
)
|
|
|
|
from .api import SqlStore
|
|
|
|
sql_store_pip_packages = ["sqlalchemy[asyncio]", "aiosqlite", "asyncpg"]
|
|
|
|
_SQLSTORE_BACKENDS: dict[str, StorageBackendConfig] = {}
|
|
|
|
|
|
SqlStoreConfig = Annotated[
|
|
SqliteSqlStoreConfig | PostgresSqlStoreConfig,
|
|
Field(discriminator="type"),
|
|
]
|
|
|
|
|
|
def get_pip_packages(store_config: dict | SqlStoreConfig) -> list[str]:
|
|
"""Get pip packages for SQL store config, handling both dict and object cases."""
|
|
if isinstance(store_config, dict):
|
|
store_type = store_config.get("type")
|
|
if store_type == StorageBackendType.SQL_SQLITE.value:
|
|
return SqliteSqlStoreConfig.pip_packages()
|
|
elif store_type == StorageBackendType.SQL_POSTGRES.value:
|
|
return PostgresSqlStoreConfig.pip_packages()
|
|
else:
|
|
raise ValueError(f"Unknown SQL store type: {store_type}")
|
|
else:
|
|
return store_config.pip_packages()
|
|
|
|
|
|
def sqlstore_impl(reference: SqlStoreReference) -> SqlStore:
|
|
backend_name = reference.backend
|
|
|
|
backend_config = _SQLSTORE_BACKENDS.get(backend_name)
|
|
if backend_config is None:
|
|
raise ValueError(
|
|
f"Unknown SQL store backend '{backend_name}'. Registered backends: {sorted(_SQLSTORE_BACKENDS)}"
|
|
)
|
|
|
|
if isinstance(backend_config, SqliteSqlStoreConfig | PostgresSqlStoreConfig):
|
|
from .sqlalchemy_sqlstore import SqlAlchemySqlStoreImpl
|
|
|
|
config = cast(SqliteSqlStoreConfig | PostgresSqlStoreConfig, backend_config).model_copy()
|
|
return SqlAlchemySqlStoreImpl(config)
|
|
else:
|
|
raise ValueError(f"Unknown sqlstore type {backend_config.type}")
|
|
|
|
|
|
def register_sqlstore_backends(backends: dict[str, StorageBackendConfig]) -> None:
|
|
"""Register the set of available SQL store backends for reference resolution."""
|
|
global _SQLSTORE_BACKENDS
|
|
|
|
_SQLSTORE_BACKENDS.clear()
|
|
for name, cfg in backends.items():
|
|
_SQLSTORE_BACKENDS[name] = cfg
|