phoenix-oss/llama-stack-mirror
0
0
Fork 1
mirror of https://github.com/meta-llama/llama-stack.git synced 2025-07-16 18:08:09 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
llama-stack-mirror/docs/source/distributions/customizing_run_yaml.md
Sumanth Kamenani 77d2c8e95d
Some checks failed
Integration Auth Tests / test-matrix (oauth2_token) (push) Failing after 9s
Details
Integration Tests / discover-tests (push) Successful in 13s
Details
Python Package Build Test / build (3.13) (push) Failing after 10s
Details
Vector IO Integration Tests / test-matrix (3.12, inline::milvus) (push) Failing after 17s
Details
Test External Providers / test-external-providers (venv) (push) Failing after 12s
Details
Vector IO Integration Tests / test-matrix (3.12, remote::pgvector) (push) Failing after 15s
Details
Python Package Build Test / build (3.12) (push) Failing after 12s
Details
Unit Tests / unit-tests (3.12) (push) Failing after 14s
Details
Vector IO Integration Tests / test-matrix (3.12, inline::sqlite-vec) (push) Failing after 20s
Details
Update ReadTheDocs / update-readthedocs (push) Failing after 14s
Details
Vector IO Integration Tests / test-matrix (3.13, inline::milvus) (push) Failing after 17s
Details
SqlStore Integration Tests / test-postgres (3.12) (push) Failing after 23s
Details
Vector IO Integration Tests / test-matrix (3.13, remote::chromadb) (push) Failing after 18s
Details
SqlStore Integration Tests / test-postgres (3.13) (push) Failing after 23s
Details
Vector IO Integration Tests / test-matrix (3.12, remote::chromadb) (push) Failing after 18s
Details
Integration Tests / test-matrix (push) Failing after 8s
Details
Vector IO Integration Tests / test-matrix (3.13, inline::sqlite-vec) (push) Failing after 18s
Details
Vector IO Integration Tests / test-matrix (3.13, remote::pgvector) (push) Failing after 16s
Details
Vector IO Integration Tests / test-matrix (3.12, inline::faiss) (push) Failing after 31s
Details
Vector IO Integration Tests / test-matrix (3.13, inline::faiss) (push) Failing after 29s
Details
Unit Tests / unit-tests (3.13) (push) Failing after 25s
Details
Pre-commit / pre-commit (push) Successful in 1m12s
Details
docs: clarify run.yaml files are starting points for customization (#2746) 
# What does this PR do?
This PR improves documentation clarity around run.yaml file usage. It
adds comprehensive guidance to help users understand that generated
run.yaml files are templates meant to be customized for production use,
not used as-is.

## Changes
- Add new documentation section on customizing run.yaml files
- Clarify that generated run.yaml files are templates, not production
configs
- Add guidance on customization best practices and common scenarios  
- Update existing documentation to reference customization guide
- Improve clarity around run.yaml file usage for better user experience

## Test Plan
- Verified new documentation file exists at correct location
- Confirmed documentation is properly integrated into the toctree
structure
- Checked all internal links use correct paths and reference existing
files
- Validated references are added to relevant existing documentation
files
- Documentation build testing will be handled by CI environment
2025-07-14 09:53:13 -07:00

1.6 KiB
Raw Blame History

Customizing run.yaml Files

The run.yaml files generated by Llama Stack templates are starting points designed to be customized for your specific needs. They are not meant to be used as-is in production environments.

Key Points

  • Templates are starting points: Generated run.yaml files contain defaults for development/testing
  • Customization expected: Update URLs, credentials, models, and settings for your environment
  • Version control separately: Keep customized configs in your own repository
  • Environment-specific: Create different configurations for dev, staging, production

What You Can Customize

You can customize:

  • Provider endpoints: Change http://localhost:8000 to your actual servers
  • Swap providers: Replace default providers (e.g., swap Tavily with Brave for search)
  • Storage paths: Move from /tmp/ to production directories
  • Authentication: Add API keys, SSL, timeouts
  • Models: Different model sizes for dev vs prod
  • Database settings: Switch from SQLite to PostgreSQL
  • Tool configurations: Add custom tools and integrations

Best Practices

  • Use environment variables for secrets and environment-specific values
  • Create separate run.yaml files for different environments (dev, staging, prod)
  • Document your changes with comments
  • Test configurations before deployment
  • Keep your customized configs in version control

Example structure:

your-project/
├── configs/
│   ├── dev-run.yaml
│   ├── prod-run.yaml
└── README.md

The goal is to take the generated template and adapt it to your specific infrastructure and operational needs.