mirror of
https://github.com/meta-llama/llama-stack.git
synced 2025-10-24 00:47:00 +00:00
**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.
205 lines
6.1 KiB
Python
205 lines
6.1 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 datetime import datetime
|
|
|
|
import pytest
|
|
import yaml
|
|
|
|
from llama_stack.core.configure import (
|
|
LLAMA_STACK_RUN_CONFIG_VERSION,
|
|
parse_and_maybe_upgrade_config,
|
|
)
|
|
|
|
|
|
@pytest.fixture
|
|
def config_with_image_name_int():
|
|
return yaml.safe_load(
|
|
f"""
|
|
version: {LLAMA_STACK_RUN_CONFIG_VERSION}
|
|
image_name: 1234
|
|
apis_to_serve: []
|
|
built_at: {datetime.now().isoformat()}
|
|
storage:
|
|
backends:
|
|
kv_default:
|
|
type: kv_sqlite
|
|
db_path: /tmp/test_kv.db
|
|
sql_default:
|
|
type: sql_sqlite
|
|
db_path: /tmp/test_sql.db
|
|
stores:
|
|
metadata:
|
|
backend: kv_default
|
|
namespace: metadata
|
|
inference:
|
|
backend: sql_default
|
|
table_name: inference
|
|
conversations:
|
|
backend: sql_default
|
|
table_name: conversations
|
|
responses:
|
|
backend: sql_default
|
|
table_name: responses
|
|
providers:
|
|
inference:
|
|
- provider_id: provider1
|
|
provider_type: inline::meta-reference
|
|
config: {{}}
|
|
safety:
|
|
- provider_id: provider1
|
|
provider_type: inline::meta-reference
|
|
config:
|
|
llama_guard_shield:
|
|
model: Llama-Guard-3-1B
|
|
excluded_categories: []
|
|
disable_input_check: false
|
|
disable_output_check: false
|
|
enable_prompt_guard: false
|
|
memory:
|
|
- provider_id: provider1
|
|
provider_type: inline::meta-reference
|
|
config: {{}}
|
|
"""
|
|
)
|
|
|
|
|
|
@pytest.fixture
|
|
def up_to_date_config():
|
|
return yaml.safe_load(
|
|
f"""
|
|
version: {LLAMA_STACK_RUN_CONFIG_VERSION}
|
|
image_name: foo
|
|
apis_to_serve: []
|
|
built_at: {datetime.now().isoformat()}
|
|
storage:
|
|
backends:
|
|
kv_default:
|
|
type: kv_sqlite
|
|
db_path: /tmp/test_kv.db
|
|
sql_default:
|
|
type: sql_sqlite
|
|
db_path: /tmp/test_sql.db
|
|
stores:
|
|
metadata:
|
|
backend: kv_default
|
|
namespace: metadata
|
|
inference:
|
|
backend: sql_default
|
|
table_name: inference
|
|
conversations:
|
|
backend: sql_default
|
|
table_name: conversations
|
|
responses:
|
|
backend: sql_default
|
|
table_name: responses
|
|
providers:
|
|
inference:
|
|
- provider_id: provider1
|
|
provider_type: inline::meta-reference
|
|
config: {{}}
|
|
safety:
|
|
- provider_id: provider1
|
|
provider_type: inline::meta-reference
|
|
config:
|
|
llama_guard_shield:
|
|
model: Llama-Guard-3-1B
|
|
excluded_categories: []
|
|
disable_input_check: false
|
|
disable_output_check: false
|
|
enable_prompt_guard: false
|
|
memory:
|
|
- provider_id: provider1
|
|
provider_type: inline::meta-reference
|
|
config: {{}}
|
|
"""
|
|
)
|
|
|
|
|
|
@pytest.fixture
|
|
def old_config():
|
|
return yaml.safe_load(
|
|
f"""
|
|
image_name: foo
|
|
built_at: {datetime.now().isoformat()}
|
|
apis_to_serve: []
|
|
routing_table:
|
|
inference:
|
|
- provider_type: remote::ollama
|
|
config:
|
|
host: localhost
|
|
port: 11434
|
|
routing_key: Llama3.2-1B-Instruct
|
|
- provider_type: inline::meta-reference
|
|
config:
|
|
model: Llama3.1-8B-Instruct
|
|
routing_key: Llama3.1-8B-Instruct
|
|
safety:
|
|
- routing_key: ["shield1", "shield2"]
|
|
provider_type: inline::meta-reference
|
|
config:
|
|
llama_guard_shield:
|
|
model: Llama-Guard-3-1B
|
|
excluded_categories: []
|
|
disable_input_check: false
|
|
disable_output_check: false
|
|
enable_prompt_guard: false
|
|
memory:
|
|
- routing_key: vector
|
|
provider_type: inline::meta-reference
|
|
config: {{}}
|
|
api_providers:
|
|
telemetry:
|
|
provider_type: noop
|
|
config: {{}}
|
|
"""
|
|
)
|
|
|
|
|
|
@pytest.fixture
|
|
def invalid_config():
|
|
return yaml.safe_load(
|
|
"""
|
|
routing_table: {}
|
|
api_providers: {}
|
|
"""
|
|
)
|
|
|
|
|
|
def test_parse_and_maybe_upgrade_config_up_to_date(up_to_date_config):
|
|
result = parse_and_maybe_upgrade_config(up_to_date_config)
|
|
assert result.version == LLAMA_STACK_RUN_CONFIG_VERSION
|
|
assert "inference" in result.providers
|
|
|
|
|
|
def test_parse_and_maybe_upgrade_config_old_format(old_config):
|
|
result = parse_and_maybe_upgrade_config(old_config)
|
|
assert result.version == LLAMA_STACK_RUN_CONFIG_VERSION
|
|
assert all(api in result.providers for api in ["inference", "safety", "memory", "telemetry"])
|
|
safety_provider = result.providers["safety"][0]
|
|
assert safety_provider.provider_type == "inline::meta-reference"
|
|
assert "llama_guard_shield" in safety_provider.config
|
|
|
|
inference_providers = result.providers["inference"]
|
|
assert len(inference_providers) == 2
|
|
assert {x.provider_id for x in inference_providers} == {
|
|
"remote::ollama-00",
|
|
"inline::meta-reference-01",
|
|
}
|
|
|
|
ollama = inference_providers[0]
|
|
assert ollama.provider_type == "remote::ollama"
|
|
assert ollama.config["port"] == 11434
|
|
|
|
|
|
def test_parse_and_maybe_upgrade_config_invalid(invalid_config):
|
|
with pytest.raises(KeyError):
|
|
parse_and_maybe_upgrade_config(invalid_config)
|
|
|
|
|
|
def test_parse_and_maybe_upgrade_config_image_name_int(config_with_image_name_int):
|
|
result = parse_and_maybe_upgrade_config(config_with_image_name_int)
|
|
assert isinstance(result.image_name, str)
|