phoenix-oss/llama-stack-mirror
0
0
Fork 1
mirror of https://github.com/meta-llama/llama-stack.git synced 2025-12-23 19:03:58 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
llama-stack-mirror/docs/source/distributions/customizing_run_yaml.md
skamenan7 9613c63ca6 docs: clarify run.yaml files are starting points for customization 
- 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

This enhancement makes it clearer for users that run.yaml files are meant
to be customized for production use, improving the overall developer experience.
2025-07-14 11:22:15 -04: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.