docs(readme): lead the quickstart with the single-container declarative run - #821
docs(readme): lead the quickstart with the single-container declarative run#821moonming wants to merge 1 commit into
Conversation
…ve run The quickstart still claimed "AISIX is etcd-backed, so the fastest local run is Docker Compose (gateway + etcd)" and sent readers to the docs to fetch a compose file and then configure a model and key through the admin API. Since v0.4.0 a standalone gateway loads every resource from one resources.yaml, so the fastest path is one docker run with no configuration store and no admin API choreography. Make the README self-contained: show the resources.yaml and config.yaml inline, then the docker run and the first proxied request. Point at the deployment docs for the etcd / control-plane path instead.
|
Warning Review limit reached
Next review available in: 57 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
1 participant
Why
The README quickstart still says "AISIX is etcd-backed, so the fastest local run is Docker Compose (gateway + etcd)", then sends the reader off-site to fetch a compose file and configure a model and caller key through the admin API. That has been the slower path since v0.4.0 shipped declarative standalone config — a gateway now loads every resource from one
resources.yamlwith no configuration store at all.Since the README is the first landing spot for anyone arriving from a link, it should show the fastest path and be runnable without leaving the page.
What
Quickstart now shows, inline:
resources.yaml(provider key + model + caller key), a minimalconfig.yamlpointing at it, onedocker run, and the first OpenAI-shaped request. Adds a pointer to the etcd / control-plane path for multi-gateway setups.Verified
Every command and claim was executed verbatim against
ghcr.io/api7/aisix:latest(v0.5.0) before writing:docker runwith those two exact files → container up,GET /livez→okGET /v1/modelswith the caller key →["gpt-4o-mini"]POST /v1/chat/completions→ request proxied to the upstream with the stored provider key (401 only because the test used a deliberately fake OpenAI key)aisix validate --resources→OK: loaded 3 resource(s); on a danglingprovider_keyreference it reports the entry, the field, and the set of defined namesadmin.admin_keysis confirmed required even though the standalone admin surface is read-only, so the example includes it rather than omitting itDocs-only change.