mirror of
https://github.com/meta-llama/llama-stack.git
synced 2025-10-22 08:17:18 +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.
42 lines
1.9 KiB
Python
42 lines
1.9 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 Any
|
|
|
|
from pydantic import BaseModel, Field
|
|
|
|
from llama_stack.core.storage.datatypes import SqlStoreReference
|
|
|
|
|
|
class S3FilesImplConfig(BaseModel):
|
|
"""Configuration for S3-based files provider."""
|
|
|
|
bucket_name: str = Field(description="S3 bucket name to store files")
|
|
region: str = Field(default="us-east-1", description="AWS region where the bucket is located")
|
|
aws_access_key_id: str | None = Field(default=None, description="AWS access key ID (optional if using IAM roles)")
|
|
aws_secret_access_key: str | None = Field(
|
|
default=None, description="AWS secret access key (optional if using IAM roles)"
|
|
)
|
|
endpoint_url: str | None = Field(default=None, description="Custom S3 endpoint URL (for MinIO, LocalStack, etc.)")
|
|
auto_create_bucket: bool = Field(
|
|
default=False, description="Automatically create the S3 bucket if it doesn't exist"
|
|
)
|
|
metadata_store: SqlStoreReference = Field(description="SQL store configuration for file metadata")
|
|
|
|
@classmethod
|
|
def sample_run_config(cls, __distro_dir__: str) -> dict[str, Any]:
|
|
return {
|
|
"bucket_name": "${env.S3_BUCKET_NAME}", # no default, buckets must be globally unique
|
|
"region": "${env.AWS_REGION:=us-east-1}",
|
|
"aws_access_key_id": "${env.AWS_ACCESS_KEY_ID:=}",
|
|
"aws_secret_access_key": "${env.AWS_SECRET_ACCESS_KEY:=}",
|
|
"endpoint_url": "${env.S3_ENDPOINT_URL:=}",
|
|
"auto_create_bucket": "${env.S3_AUTO_CREATE_BUCKET:=false}",
|
|
"metadata_store": SqlStoreReference(
|
|
backend="sql_default",
|
|
table_name="s3_files_metadata",
|
|
).model_dump(exclude_none=True),
|
|
}
|